Customer Get Api
Retrieves a customer by their UUID.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
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'.
The unique identifier for the customer.
"123e4567-e89b-12d3-a456-426614174000"
The name of the customer.
"John Doe"
The name of the contact person for the customer.
"John Doe"
The primary email address of the customer.
"john.doe@example.com"
A list of additional email addresses for the customer.
[
"john.doe@example.com",
"jane.doe@example.com"
]
A list of email addresses used for billing purposes.
[
"john.doe@example.com",
"jane.doe@example.com"
]
The customer's phone number, including country code.
"+1234567890"
The currency used by the customer.
"USD"
The customer's tax identification number.
"1234567890"
The customer's billing address.
The customer's shipping address.
An optional external identifier for the customer. This can be used to link the customer to an external system.
"CUST-001"