Contacts
List contacts
Changed onLists 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
Request
- Base URLhttps://messenger-public-api.cogfy.com
- AuthAPI key in header api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
cursorstring
Opaque cursor returned by a previous call, used to fetch the next page
waIdstring
Filters by the WhatsApp id of the contact
phoneNumberstring
Filters by the phone number of the contact
Response
A page of contacts
Changes
- breaking
api path removed without deprecation
- info
endpoint added
- breaking
- info
added the optional property
//to the response with the status
- info