Contacts: Search Contacts
gapify_search_contactsSearch resolved contacts by name, email, phone, or identifier, supporting Persian names and digits. Returns 15 results per page to help locate customer records.
Instructions
Search resolved contacts by name, identifier, email or phone number (15 per page). Persian names and Persian-digit phone numbers are accepted [Contacts]
GET /api/v1/accounts/{account_id}/contacts/search
Auth: User API key (header api-access-token).
Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Query param. Search using contact `name`, `identifier`, `email` or `phone number` | |
| page | No | Query param. The page parameter Example: 1 | |
| sort | No | Query param. The attribute by which list should be sorted One of: `name`, `email`, `phone_number`, `last_activity_at`, `-name`, `-email`, `-phone_number`, `-last_activity_at` Example: name | |
| account_id | Yes | The numeric ID of the account |