Skip to main content
GET
Get a customer

Authorizations

x-api-key
string
header
required

Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.

Keys are scoped. A key needs conversations:send to send, conversations:read to read threads and messages, templates:read to list templates, and channels:read to list channels. A key missing the scope for an endpoint gets 403.

The CRM endpoints use the same resource:action form: leads:read, leads:create, leads:update, leads:delete, customers:read, customers:create, customers:update, customers:delete, customers:manage.

Several resources have no scope of their own and borrow one:

Grant only what the integration needs — a key that only sends notifications should hold conversations:send and nothing else.

X-Tenant-Id
string
header
required

Your workspace UUID. Required on every request in addition to x-api-key.

It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.

Path Parameters

id
string<uuid>
required

Response

The customer.

A company or account. The people at it are contacts.

id
string<uuid>
name
string
company_name
string
industry
string
website
string
email
string
phone
string
address
object
customer_type
enum<string>
Available options:
individual,
business
status
enum<string>
Available options:
active,
inactive,
prospect,
archived
source
enum<string>
Available options:
website,
referral,
import,
manual,
api
assigned_to_user_id
string<uuid>
tags
string<uuid>[]

Tag IDs. Resolve them with GET /tags.

custom_fields
object
created_at
string<date-time>
updated_at
string<date-time>