Skip to content

Count contacts

GET
/contacts/count

Returns the total number of contacts in the tenant matching the optional search, type, dateFrom/dateTo filters. Mirrors the same filters as GET /contacts minus pagination — use this when you only need cardinality and don’t want to walk every page.

type
string
search
string
dateFrom
string format: date-time
dateTo
string format: date-time

Count

object
data
required
object
total
required
integer
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

Scope insufficient

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string