List pinned contact views

GET

contacts

views

pinned

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

{
  "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"
        }
      ]
    }
  ]
}

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.

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

Authorizations

X-Claap-Key

string

header

required

Query Parameters

userEmail

string<email>

required

Email address of the user whose pinned views are listed. It must belong to an active workspace member.

Example:

"jane.doe@example.com"

Response

Pinned contact views were successfully retrieved

result

object[]

required

Show child attributes

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

{
  "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"
        }
      ]
    }
  ]
}

API documentation

Recording

Deal

Company

Contact

Folder

Admin automation

Workspace

User

Invite

User group

Webhook

List pinned contact views

Authorizations

Query Parameters

Response