Skip to main content
GET
cURL
Lists the contacts of the workspace, sorted by name ascending by default and paginated with a cursor. Contacts bound to a workspace user (userId set, isExternal false) are included but cannot be modified with the update endpoint.

Authorizations

X-Claap-Key
string
header
required

Query Parameters

cursor
string

Paginate the results starting at the cursor returned by a previous call.

limit
number
default:20

Return at most "limit" results.

Required range: 1 <= x <= 100
sort
enum<string>

Sort results according to specified rule. Defaults to the sorting of "viewId" when set, "name_asc" otherwise.

Available options:
email_asc,
email_desc,
last_interaction_asc,
last_interaction_desc,
name_asc,
name_desc
viewId
string

Return the contacts of the specified view: its filters and sorting apply, and the sort parameter overrides the view sorting. Use GET /v1/contacts/views to discover views.

Response

Contacts were successfully retrieved

result
object
required