Skip to main content
SearchVersion: v3

Count Contacts

POST/contacts/search/count

Count the contacts that match a search, without returning them. Takes the same query and filters as Search Contacts. Large counts can take up to 35 seconds. If the count does not finish in time, the response is { "count": null }; retry the request.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:contacts.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version. Send v3.

Available optionsv3
Example:v3

Body

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT
querystring

Free-text search, the same as query on Search Contacts

Example:john
filtersobject[]

Filters, or groups of filters, the same as filters on Search Contacts. Top-level items are combined with AND.

Response

Success

countnumbernullablerequired

Number of contacts that match the request. null when the count did not finish in time; retry.

Example:120