Find contacts
GET {{baseUrl}}/contacts?fields=<string>&limit=<integer>&offset=<integer>&id=<integer>&number=<string>&contactListId=<integer>&propertyName=<string>&propertyValue=<string>
Find user's contacts by id, contact list, or on any property name. Returns a paged list of contacts
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page. | |
limit | string | To set the maximum number of records to return in a paged list response. The default is 100 | |
offset | string | Offset to the start of a given page. The default is 0. Check pagination page for more information about pagination in CallFire API. | |
id | string | Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored | |
number | string | Multiple contact numbers can be specified. If the number parameter is included, the other query parameters are ignored. | |
contactListId | string | Filters contacts by a particular contact list | |
propertyName | string | Name of a contact property to search by | |
propertyValue | string | Value of a contact property to search by |