Search Contact
Search contacts by name, identifier, email or phone number (Page size = 15).
Settings:
URL | https://online.99digital.co.il/api/v1/accounts/{account_id}/contacts/search |
Method | JSON via GET |
Authorization:
Header Parameter | Description |
api_access_token | user API key |
The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.
Path Parameters:
Parameter | Description | Required |
account_id | The numeric id of the account | yes |
Query Parameters:
Parameter | type | Description | Required |
q | string | Search using contact name, identifier, email or phone number | yes |
sort | string | The attribute by which list should be sorted Enum: | no |
page | integer | The page parameter Default: | no |
Response-Explain:
Parameter | Description |
meta | Metadata regarding the search results |
meta -> count | Number of contacts in the account |
meta -> current_page | Current results page |
payload | Array of objects (contacts) |
payload -> id | Contact numeric id |
payload -> name | Full name of the contact |
payload -> email | Email address of the contact |
payload -> phone_number | Phone number of the contact |
payload -> availability_status | Availability status of the contact |
payload -> identifier | A unique identifier for the contact in external system |
payload -> thumbnail | Avatar URL of the contact |
payload -> conversations_count | Contact's number of conversations |
payload -> last_activity_at | Timestamp of the last activity |
payload -> blocked | Whether the contact is blocked |
payload -> created_at | Timestamp of contact creation time. Measured in seconds since the Unix epoch |
payload -> custom_attributes | The object to save custom attributes for contact, accepts custom attributes key and value |
payload -> additional_attributes | The object containing additional attributes related to the contact |
payload -> contact_inboxes | Array of objects (contact_inboxes) |
payload -> contact_inboxes -> source_id | Contact inbox source id |
payload -> contact_inboxes -> inbox | Object containing the inbox details |