Skip to main content
GET
Get a customer

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.

Path Parameters

id
string<uuid>
required

Resource UUID.

Response

Customer detail

id
string<uuid>
required
Example:

"c0ffee00-0000-4000-8000-000000000001"

name
string
required
Example:

"Acme Co"

parent_id
string<uuid> | null

Direct CRM parent account, if this is a child account.

parent_name
string | null

Parent account name.

domain
string
Example:

"acme.example"

industry
string
Example:

"Software"

employee_count
integer
Example:

250

arr
number | null

Current annual recurring revenue in your team's currency. 0 when the customer does not pay now; null when unknown.

Example:

48000

currency
string
Example:

"USD"

is_active_customer
boolean | null

Whether your CRM marks this account as an active customer. Null when unknown, which is not the same as false.

Example:

true

is_paying
boolean | null

Whether this customer pays now, decided for its whole family. Null when not known yet.

Example:

true

churn_state
enum<string>
Available options:
active,
at_risk,
churned
Example:

"active"

insight_count
integer
Example:

23

last_seen
string<date-time> | null

Latest known insight source date; null when unknown.

Example:

"2026-06-10T09:00:00Z"

external_ids
object[]

This customer's records in your connected tools: the connection, the tool, and its id there.

parents
object[]

Accounts above this one in your CRM hierarchy, nearest first, up to 10 levels. Empty for a top-level account.

family
object | null

The family this account belongs to. Theme and feature customer counts count each family once.