GET/v1/contacts/countbeta

Count contacts

Counts contacts that match the same filters as List contacts, without listing them. Handy before a big sync.

Try it

Query (6)

queryoptionalstring

Name or phone contains this text.

group_idsoptionallist

Contacts in ANY of these groups.

tag_idsoptionallist

Contacts with ANY of these tags (repeat the parameter).

starredoptionalboolean

`true` = starred contacts only.

dndoptionalboolean

`true` = do-not-disturb on; `false` = can receive broadcasts.

not_in_any_groupoptionalboolean

`true` = contacts in no group.

This only reads. It uses your real data and changes nothing.

curl -X GET 'https://mcp.wa-api.cloud/v1/contacts/count?dnd=true' \
  -H "Authorization: Bearer $API_KEY"

The code reads your key from $API_KEY.

Parameters
Field	Type	What it is
query	string · query	Name or phone contains this text.1–100 characters
group_ids	array of string \| integer · query	Contacts in ANY of these groups.0–50 items
tag_ids	array of string \| integer · query	Contacts with ANY of these tags (repeat the parameter).0–50 itemsSigned in? Pick one from your data with “My data”.
starred	boolean · query	`true` = starred contacts only.
dnd	boolean · query	`true` = do-not-disturb on; `false` = can receive broadcasts.
not_in_any_group	boolean · query	`true` = contacts in no group.

Headers
Field	Type	What it is
Authorizationrequired	header	`Bearer $API_KEY` — your API key.
Api-Version	header	The API version to use, e.g. `2026-10-01`. Default: the version your key is pinned to.one of: `2026-10-01` · pattern `^\d{4}-\d{2}-\d{2}$`

The count.

Response fields
Field	Type	What it is
countrequired	integer	-9007199254740991–9007199254740991
approximaterequired	boolean	true when the count is an estimate.
resolved_dates	array of object	Relative or local dates in filter and the absolute instants they were run with.
pathrequired	string
inputrequired	string
valuerequired	string
warnings	array of object	Filter conditions that may not mean what they look like: {path, message}.
path	string
messagerequired	string

Errors are application/problem+json. Branch on code.

Status	Code	When
400	invalid_input	A field is missing or has the wrong format. `errors[]` points at each field.
401	unauthenticated	The Authorization header is missing, the key is unknown, expired or revoked.
403	entitlement_required	The workspace's plan does not include API access (`api_access`).
403	insufficient_scope	The key does not have the permission this operation needs.
429	rate_limited	The key or workspace went over its rate limit. Wait for `Retry-After` seconds.
503	upstream_unavailable	A service behind the API is briefly unavailable. Safe to retry with backoff.

How many contacts opted out

Response 200

{
  "count": 312,
  "approximate": false
}

The same operation is also at POST /v1/ops/crm_count_contacts, with every field in the JSON body.