Skip to main content
POST
/
api
/
contacts
/
counts
Get contact counts for filters
curl --request POST \
  --url https://your-instance.example.com/api/contacts/counts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search": "jane",
  "source": "WebForm"
}
'
{
  "all": 124,
  "my": 38
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
search
string

Case-insensitive regex matched against firstName, lastName, and phone-number value.

​
source
string

Exact-match filter on the contact source field.

Response

Counts returned

​
{key}
integer