v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
contacts

Find contacts

Find user's contacts by id, contact list, or on any property name. Returns a paged list of contacts

get/contacts

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

limitinteger

To set the maximum number of records to return in a paged list response. The default is 100

offsetinteger

Offset to the start of a given page. The default is 0. Check pagination page for more information about pagination in CallFire API.

idinteger[]

A list of contact IDs. If the id parameter is included, the other query parameters are ignored.

numberstring[]

Multiple contact numbers can be specified. If the number parameter is included, the other query parameters are ignored.

contactListIdinteger

Filters contacts by a particular contact list

propertyNamestring

Name of a contact property to search by

propertyValuestring

Value of a contact property to search by

Response

successful operation

limitinteger

A maximum number of returned items. If items.size() < limit assume no more items

offsetinteger

An offset from a start of paging source

totalCountinteger

Total count of available results. -1 if unknown