Sign in
Contacts

List contacts

Lists the contacts of the workspace, 25 per page.

Any query parameter other than cursor, waId and phoneNumber is treated as a filter on a custom contact property of the workspace — e.g. ?plan=premium returns the contacts whose plan property equals premium.

When more results are available, cursors.next is returned. Pass it back as cursor to fetch the next page; the original filters are preserved by the cursor.

get/contacts

Query parameters

cursorstring

Opaque cursor returned by a previous call, used to fetch the next page

Opaque cursor returned by a previous call, used to fetch the next page

waIdstring

Filters by the WhatsApp id of the contact

Filters by the WhatsApp id of the contact

phoneNumberstring

Filters by the phone number of the contact

Filters by the phone number of the contact

Response

A page of contacts

Changes

Changed in 4 of the 9 revisions of this API.114

  • 8ccfb9a461e211See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    • ○

      endpoint added

      endpoint-added

  • e21feba47bec1See the full diff
    • ○

      added the optional property data/items/customProperties to the response with the 200 status

      response-optional-property-added

  • e345c865fde911See the full diff
    • ●

      removed the optional property data/items/cursors from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property cursors to the response with the 200 status

      response-optional-property-added

  • 5fbcb3c079671See the full diff
    • ○

      added the new optional query request parameter waId

      new-optional-request-parameter