Skip to main content
GET
List / search customers

Authorizations

X-API-Key
string
header
required

Team-scoped API key created in the app (Settings → API Keys). Sent as X-API-Key: <key> on every request.

Query Parameters

q
string

Free-text search over titles and content.

is_active_customer
boolean

Filter to active paying customers.

parent_id
string<uuid>

Return the child customers under this parent account (account family).

parents_only
boolean

Return only top-level parent accounts, rolling up child properties.

limit
integer
default:50

Page size (max 200).

Required range: 1 <= x <= 200
offset
integer
default:0

Number of records to skip.

Required range: x >= 0

Response

200 - application/json

A page of customers

data
object[]
pagination
object