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