Sign in

v2

latestOpenAPI 3.0.02026-07-26365590.3 KB
Contacts

List contacts

Returns a paginated list of contacts scoped to the workspaces accessible by the API key. Use the workspaceIds query parameter to narrow results to a subset of those workspaces.

get/v1/contacts

Query parameters

workspaceIdsstring
Example:550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8

Workspace IDs to narrow down results. Must be a subset of the workspaces accessible by the API key. Omit to return data from every workspace in scope. Accepts either a comma-separated string (?workspaceIds=uuid1,uuid2) — the documented format — or repeated array params (?workspaceIds[]=uuid1&workspaceIds[]=uuid2).

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:10

Number of items per page

searchstring
Example:john

Search query to filter contacts by name, email, or company

Response

Paginated list of contacts

totalnumber required
pagenumber required
limitnumber required
totalPagesnumber required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "firstName": "John",
      "lastName": "Doe",
      "allowPhoneCalls": true,
      "callCount": 5,
      "teamId": "550e8400-e29b-41d4-a716-446655440000",
      "phoneNumbers": [
        "+33612345678"
      ],
      "customFields": {
        "Industry": "Technology",
        "Size": "50-100"
      }
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}