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. The header name apikey is also accepted as an alias.

Query Parameters

q
string

Free-text search over titles and content.

is_active_customer
boolean

true returns accounts your CRM marks as active customers; false returns accounts it marks as not active. Accounts with an unknown status are not returned by either value; omit the filter to include them. For who pays, use is_paying.

is_paying
enum<boolean>

Return only paying customers. Only true is accepted.

Available options:
true
parent_id
string<uuid>

Return the child accounts under this CRM parent account.

parents_only
boolean

Return only top-level accounts.

family_id
string<uuid>

Return the accounts in one family. Use the family.id shown on any of its accounts.

external_id
string

Find a customer by its id in the tool it came from, such as a Salesforce Account Id (exact match).

Required string length: 1 - 255
has_insights
enum<boolean>

Return only accounts with at least one insight (insight_count above 0). Only true is accepted.

Available options:
true
sort
enum<string>

insight_count sorts by insight_count, highest first, then by name, then by id. Requires has_insights=true; without it the request is refused with a 400. Omit for the default order by id.

Available options:
insight_count
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

A page of customers

data
object[]
pagination
object