Parameters
Basic Details
The following details are fetched by default when you make a Contacts API call.
- contact_id
- contact_zuid
- first_name
- middle_name
- last_name
- status
- photo_url
- gender
- notes
- birth_day
- birth_month
- birth_year
- company
- job_title
- designation
- created_time (in milliseconds)
- updated_time (in milliseconds)
Specific Details
The following details are fetched only when using the include=specific_detail while fetching contacts. For instance, include=emails
Note: You can query multiple specific details uisng include by separating the specific details using comma. For instance, include=emails,phones,address
- emails (to get all emails)
- emails.primary (to only get the primary emails)
- phones
- address
- urls
- ims (instant messaging service)
- categories (much like groups)
- show_deleted (for sync)
Parameter Descriptions
| Parameter | Description |
|---|---|
| include | Request multiple specific details (in CSV format) which you require for your business logic. |
| page | Get a specific set of contacts like the 1st N contacts or the 2nd N contacts where N is defined by the per_page parameter. |
| per_page | Specify the number of contacts in a single set to be fetched. Note: 50 contacts are fetched by default. |
| sort | Sort the results by first_name, last_name, or usage_count. Note: prepend '-' for descending order. |
| filter_categories | Fetch all the contacts under a particular categoryId |
| filter_updated_time | Fetch contacts after a particular updated_time. Note: All contacts will be fetched by default. |
| fields | Fetch specific data like contacts count. |
| q | Search contacts based on the input query given. |