Skip to content

Contacts

List contacts

Returns the workspace’s contacts as a JSON array, newest first. The list is capped at 500 contacts and has no paging or filter parameters.

GET/api/v1/contacts
  • Bearer API key
  • Scope: read or write
  • or app session
  • Workspace: X-Tenant-ID (optional with a key)

Headers

  • Authorizationstringrequired

    Your API key as Bearer <key>. The word Bearer and the space are case-sensitive. Browser clients signed in to the app use the session cookie instead.

    Constraints
    Keys start with pk_live_ and are 56 characters long.
    Example
    Bearer pk_live_…
  • X-Tenant-IDuuidoptional

    Workspace id. Optional with an API key (a key always acts in its own workspace); if you send it, it must match the key’s workspace. Required with a session cookie. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Response

200 OKapplication/json

  • []array<Contact>

    Up to 500 contacts, newest first.

    Show child attributesHide child attributes7
    • iduuid

      Contact id.

    • namestring

      Contact name.

    • phonestring

      Phone number with country code, digits only (no +).

    • tagstring

      Free-text tag (may be empty).

    • opted_ininteger

      1 if the contact agreed to receive messages, otherwise 0.

    • created_atinteger

      Creation time in Unix seconds.

    • avatar_urlstringmay be absent

      Profile picture URL, when one has been downloaded.

Status codes

  • 200OK. An array of contacts (not wrapped in an object). Empty array when there are none.
  • 401Unauthorized. The API key is unknown, revoked or expired (invalid or expired API key), or there is no key and no signed-in session (unauthorized).
  • 402Payment required. Only when subscriptions are enforced and the workspace has no active subscription. The body includes code: "payment_required".
  • 403Forbidden. The X-Tenant-ID header or tenant query does not match the API key’s workspace (API key belongs to a different workspace), or a signed-in user is not a member of the workspace (forbidden).
  • 500Server error. The contacts could not be loaded.