Skip to content

Count contacts

Request

Count contacts matching a filter without returning the full data. Use all: true to count every contact in the team, or pass an explicit list of contact UUIDs in ids (with all: false) to count a specific subset.

Security
bearerAuth
Bodyapplication/jsonrequired
idsArray of strings, (uuid)

Specific contact UUIDs to count. Required when all is false.

Example:
[ "02dcb6ac-9b15-49f6-8882-fbca91e986ab" ]
allboolean

When true, count every contact in the team and ignore ids.

Default:false
filterobject

Optional filter object — same shape as /leads/api/leads/search.

POST
/leads/api/leads/count
curl -i -X POST \
  https://leadgen.grinfi.io/leads/api/leads/count \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "all": true
  }'

Responses

Count of matching contacts.

Bodyapplication/json
totalinteger
Example:1234
Response
{ "total": 1234 }