> ## Documentation Index
> Fetch the complete documentation index at: https://docs.claap.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List pinned contact views

> List the contact views a user has pinned to the tab bar of the contacts table, in tab order. Private views the user can access are included. Views the user can no longer access are left out.

Lists the contact views a user has pinned to the tab bar of the contacts table, in tab order. A user who never changed their tab bar gets the built-in default views.

Pinned views follow the same access rules as the Claap application: they include the private views the user can access, and leave out views the user can no longer access. See [pinned views](/api-reference/views#pinned-views).

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.claap.io/v1/contacts/views/pinned?userEmail=jane.doe%40example.com' \
    --header 'X-Claap-Key: <api-key>'
  ```
</RequestExample>


## OpenAPI

````yaml GET /v1/contacts/views/pinned
openapi: 3.1.0
info:
  title: Claap API
  description: Development documentation
  version: 0.0.0
servers:
  - url: https://api.claap.io/
security:
  - ApiKey: []
paths:
  /v1/contacts/views/pinned:
    get:
      description: >-
        List the contact views a user has pinned to the tab bar of the contacts
        table, in tab order. Private views the user can access are included.
        Views the user can no longer access are left out.
      operationId: getV1ContactsViewsPinned
      parameters:
        - in: query
          name: userEmail
          schema:
            type: string
            format: email
            description: >-
              Email address of the user whose pinned views are listed. It must
              belong to an active workspace member.
            example: jane.doe@example.com
          required: true
      responses:
        '200':
          description: Pinned contact views were successfully retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/ContactView'
                required:
                  - result
              example:
                result:
                  - viewId: Vw9Bt4Hp6Nc2Rk8Df1Ws3
                    name: External contacts
                    visibility: Public
                    icon: ':handshake:'
                    isDefault: false
                    ownerId: Xk2Rd7Mv4Bn9Ts1Lq6Wf3
                    columns:
                      - type: Default
                        columnId: Name
                        isHidden: false
                      - type: Default
                        columnId: Email
                        isHidden: false
                      - type: Default
                        columnId: Company
                        isHidden: false
                    filters:
                      externalities:
                        - External
                    sort:
                      - field: Name
                        order: Asc
                  - viewId: Default_RecentlyActive
                    name: Recent
                    visibility: Public
                    icon: ':clock1:'
                    isDefault: true
                    ownerId: '#global'
                    columns:
                      - type: Default
                        columnId: Name
                        isHidden: false
                      - type: Default
                        columnId: Email
                        isHidden: false
                      - type: Default
                        columnId: LastInteraction
                        isHidden: false
                    filters: {}
                    sort:
                      - field: LastInteraction
                        order: Desc
                  - viewId: Qz6Lp1Tc9Vh3Jn7Xb4Mr2
                    name: Acme contacts
                    visibility: Private
                    isDefault: false
                    ownerId: Xk2Rd7Mv4Bn9Ts1Lq6Wf3
                    columns:
                      - type: Default
                        columnId: Name
                        isHidden: false
                      - type: Default
                        columnId: LastInteraction
                        isHidden: false
                    filters:
                      companyIdIn:
                        - '9876543210'
                    sort:
                      - field: LastInteraction
                        order: Desc
        '400':
          description: '`userEmail` is not the email address of an active workspace member.'
components:
  schemas:
    ContactView:
      type: object
      properties:
        viewId:
          type: string
          description: The view identifier.
        name:
          type: string
          description: The view name.
        visibility:
          type: string
          enum:
            - Public
            - Private
          description: >-
            The view visibility. `Private` views are only returned by the pinned
            views endpoints; the other endpoints only access `Public` views.
        icon:
          type: string
          description: The view icon.
        isDefault:
          type: boolean
          description: >-
            Whether the view is a built-in default view. Default views cannot be
            updated or deleted.
        ownerId:
          type: string
          description: >-
            Claap user identifier of the view owner, or `#global` for built-in
            default views.
        columns:
          type: array
          items:
            $ref: '#/components/schemas/ContactViewColumn'
          description: The columns of the contacts table.
        filters:
          $ref: '#/components/schemas/ContactViewFilters'
        sort:
          type: array
          items:
            $ref: '#/components/schemas/ContactViewSortDimension'
          description: The sort order of the contacts table.
      required:
        - viewId
        - name
        - visibility
        - isDefault
        - ownerId
        - columns
        - filters
        - sort
      description: A saved view of the contacts table.
    ContactViewColumn:
      type: object
      properties:
        columnId:
          type: string
          description: The built-in column identifier.
        isHidden:
          type: boolean
          description: Whether the column is hidden in the table.
          default: false
        type:
          type: string
          enum:
            - Default
          description: The column type. Only `Default` is supported today.
          default: Default
        width:
          type: number
          description: The column width, in pixels.
      required:
        - columnId
      description: A column of the contacts table.
    ContactViewFilters:
      type: object
      properties:
        companyIdIn:
          type: array
          items:
            type: string
          description: >-
            Only include contacts linked to one of these CRM company
            identifiers.
          default: []
        companyIdNotIn:
          type: array
          items:
            type: string
          description: Exclude contacts linked to one of these CRM company identifiers.
          default: []
        externalities:
          type: array
          items:
            type: string
            enum:
              - External
              - Internal
          description: >-
            Only include contacts matching one of these externalities.
            `External` matches contacts outside the workspace domain, `Internal`
            matches contacts within it.
          default: []
      description: >-
        The filters applied by the view to the contacts table. All set filters
        must match.
    ContactViewSortDimension:
      type: object
      properties:
        field:
          type: string
          enum:
            - Name
            - Email
            - Company
            - LastInteraction
          description: The field to sort contacts by.
        order:
          type: string
          enum:
            - Asc
            - Desc
          description: The sort direction.
      required:
        - field
        - order
      description: A sort dimension of the contacts table.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Claap-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.