Skip to main content
POST
Get customers count
Required scopes: customers:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
query
string

A free-text search query across name, email, and phone_number fields. Automatically excludes fields that are explicitly filtered.

Minimum string length: 3
Example:

"john smith"

filters
object[]

An array of filter groups combined with AND logic.

Response

The count of customers matching the search criteria.

count
integer<int64>
Example:

1523