Contacts

Read-only access to your project’s contacts. Contacts represent the people who have talked to you across channels.

List contacts

List contacts (cursor-paginated).

Response

200Success

{
  "results": [
    {
      "id": "7c4e9b02-1a55-4e88-b0d1-2f3a4b5c6d7e",
      "display_name": "Jane Doe",
      "notes": "VIP customer",
      "metadata": { "plan": "gold" },
      "is_blocked": false,
      "created_at": "2026-06-01T09:00:00+00:00",
      "updated_at": "2026-07-01T10:40:00+00:00"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Supports cursor and limit (default 50, max 100).

Get a contact

Retrieve a single contact by id.

Responses

200Success

{
  "id": "7c4e9b02-1a55-4e88-b0d1-2f3a4b5c6d7e",
  "display_name": "Jane Doe",
  "notes": "VIP customer",
  "metadata": { "plan": "gold" },
  "is_blocked": false,
  "created_at": "2026-06-01T09:00:00+00:00",
  "updated_at": "2026-07-01T10:40:00+00:00"
}

404Not found

{ "detail": "contact_not_found" }

The contact object

id, display_name.
notes — free-text operator notes.
metadata — arbitrary JSON attached to the contact.
is_blocked — whether the contact is blocked.
created_at, updated_at — ISO-8601.

Contact writes (create / update) aren’t part of v1 — they’re on the roadmap. Read endpoints are available today.