Sign in
latestOpenAPI 3.0.2MIT2026-08-1745267541.8 KB

bdb3e0c48bf7

Contact

List Contacts

List all contacts in the project. Note that, if a WhatsApp contact is returned, the display_name field of that contact may be populated with the WhatsApp display name (if the name is already stored on the server and the display_name field has not been overwritten by the user).

get/v1/projects/{project_id}/contacts

Query parameters

page_sizeinteger

Optional. The maximum number of contacts to fetch. The default is 10 and the maximum is 20.

page_tokenstring

Optional. Next page token previously returned if any.

external_idstring

Optional. Contact identifier in an external system. If used, channel and identity query parameters can't be used.

channel'SMS' | 'RCS' | 'WHATSAPP' | 'MMS' | 'KAKAOTALK' | 'KAKAOTALKCHAT' | 'VIBERBM' | 'LINE' | 'INSTAGRAM' | 'MESSENGER' | 'WECHAT' | 'TELEGRAM' | 'APPLEBC'

The identifier of the channel you want to include. Must be one of the enum values.

Example:WHATSAPP

Optional. Specifies a channel, and must be set to one of the enum values. If set, the identity parameter must be set and external_id can't be used. Used in conjunction with identity to uniquely identify the specified channel identity.

identitystring

Optional. If set, the channel parameter must be set and external_id can't be used. Used in conjunction with channel to uniquely identify the specified channel identity. This will differ from channel to channel. For example, a phone number for SMS, WhatsApp, and Viber Business.

Response

A successful response.

next_page_tokenstring

Token that should be included in the next list contacts request to fetch the next page.

Example response

{
  "contacts": [
    {
      "channel_identities": [
        {
          "channel": "WHATSAPP"
        }
      ],
      "channel_priority": [
        "WHATSAPP"
      ],
      "id": "{CONTACT_ID}"
    }
  ]
}