v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Contacts

Count filtered contacts

<Warning> **Coming soon.** This endpoint will be available by late July 2026. </Warning>

<small>Requires the contacts:read scope (or a broader one that includes it).</small>

Use this endpoint when you need only the number of contacts that match a set of filter criteria — for example to show a total or decide whether to page through the results — without fetching the contacts themselves. It accepts the same request body as the filter endpoint.

post/v3/contacts/filter/count

Request body

listIdinteger nullable

Filter by contact list ID

sequenceIdinteger nullable

Filter by sequence ID

sequenceStepIdinteger nullable

Filter by sequence step ID

searchTermstring nullable

Free-text search term

Response

Count retrieved successfully

countinteger required

Total number of matching items.

Example response

{
  "count": 42
}