Skip to main content
GET
Customer Get Api

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_uuid
string
required

Response

Customer retrieved successfully

Schema for retrieving customer information.

Attributes: uuid (UUID): The unique identifier for the customer. name (str): The name of the customer. contact_name (Optional[str]): The name of the contact person for the customer. email (Optional[str]): The primary email address of the customer. additional_emails (Optional[List[str]]): A list of additional email addresses for the customer. billing_emails (Optional[List[str]]): A list of email addresses used for billing purposes. phone_number (Optional[str]): The customer's phone number, including country code. currency (Optional[str]): The currency used by the customer. tax_id (Optional[str]): The customer's tax identification number. billing_address (Optional[AddressSchema]): The customer's billing address. shipping_address (Optional[AddressSchema]): The customer's shipping address. external_id (Optional[str]): An external identifier for the customer, aliased as 'external_customer_id'.

uuid
string<uuid>

The unique identifier for the customer.

Example:

"123e4567-e89b-12d3-a456-426614174000"

name
string

The name of the customer.

Example:

"John Doe"

contact_name
string | null

The name of the contact person for the customer.

Example:

"John Doe"

email
string | null

The primary email address of the customer.

Example:

"john.doe@example.com"

additional_emails
string[] | null

A list of additional email addresses for the customer.

Example:
billing_emails
string[] | null

A list of email addresses used for billing purposes.

Example:
phone_number
string | null

The customer's phone number, including country code.

Example:

"+1234567890"

currency
string | null

The currency used by the customer.

Example:

"USD"

tax_id
string | null

The customer's tax identification number.

Example:

"1234567890"

billing_address
AddressSchema · object | null

The customer's billing address.

shipping_address
AddressSchema · object | null

The customer's shipping address.

external_id
string | null

An optional external identifier for the customer. This can be used to link the customer to an external system.

Example:

"CUST-001"

external_customer_id
string | null

External customer Id

Maximum string length: 100