Skip to main content
GET
Get a customer
createdBy is the ID of the user or API client that created the customer, and customerUrl is the link to the customer’s portal page.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the customer belongs to.

Format: UUID

customerId
string<uuid>
required

ID of the customer.

Format: UUID

Response

Successful response

A customer: the person or company an organization bills.

id
string<uuid>
required

ID of the customer.

Example:

"7f3b1c52-9e4a-4d1b-8a67-2c5d9f0e4b13"

documentType
string
required

Kind of document: CPF for 11 characters, CNPJ otherwise.

Example:

"CPF"

customerUrl
string
required

Link to the customer's portal page. It is built from the portal address and hash.

Example:

"https://portal.example.com/c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f"

address
object

Postal address of the customer.

Example:
name
string

Name of the customer: a person's full name or a company's name.

Example:

"Ana Souza"

document
string

Tax ID of the customer, without formatting: a CPF (11 digits) or a CNPJ (14 characters — the first 12 may be uppercase letters, the last 2 are digits).

Example:

"52998224725"

trandingName
string

Trade name of a company customer.

Example:

"Souza Studio"

email
string

E-mail address of the customer.

Example:

"ana.souza@example.com"

phoneNumber
string

Phone number of the customer, in international format: + followed by digits. A few older records that could not be converted to this format are returned exactly as they were stored.

Example:

"+5511999999999"

createdAt
string<date-time>

When the customer was created.

Example:

"2026-03-14T12:30:00.000Z"

createdBy
string

ID of the user or API client that created the customer. The customer list does not include it.

Example:

"9b2f4c1e-5d38-4a76-b0e1-3c8a7d2f6e45"

hash
string<uuid>

Token that identifies the customer in the link of their portal page (customerUrl).

Example:

"c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f"

status
string

Status of the customer: ACTIVE or DEACTIVATED.

Example:

"ACTIVE"

customFields
object | null

Values of the organization's custom fields for this customer, keyed by the field's slug. Absent, or null, when the customer has none.


Example: {"cost-center":"CC-1020"}

Example: