v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

contacts

List contacts

Returns paginated contact summaries for a workspace, ordered by latest activity by default. Reuse cursor with the same filters to continue pagination.

get/v1/contacts

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

limitinteger

cursorstring

archived'true' | 'false'

sort_by'last_message_at' | 'follow_up_at'

order'asc' | 'desc'

inbox_type_idstring

Response

Contacts

next_cursorstring nullable required

has_moreboolean required

Example response

{
  "data": [
    {
      "id": "ph77c0dy0mgdpzmqz6tesry8w184002s",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "first_name": "Jane",
      "last_name": "Doe",
      "image_url": null,
      "type": null,
      "inbox_type_id": "guest",
      "archived": false,
      "ai_paused": false,
      "last_channel": "unthreaded_email",
      "last_message_at": "2026-04-03T03:14:15.000Z",
      "last_message_preview": "Can I check in early?",
      "created_at": "2026-04-01T17:22:10.000Z",
      "updated_at": "2026-04-03T03:14:15.000Z"
    }
  ],
  "next_cursor": "page-token",
  "has_more": true
}