Theme switcher

Get Customer

Retrieve a single customer by their UUID. Use this endpoint when you need complete details about a specific customer.

UUID Format: Must be a valid UUID v4 format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Response Data: Returns the complete customer object including:

  • All customer fields (name, email, phone, website, status)
  • Billing and shipping addresses
  • All associated contacts
  • Tax settings (read-only)
  • Timestamps (createdAt, updatedAt)

Use Cases:

  • Retrieving full customer details before updating
  • Displaying customer information in your application
  • Verifying customer exists before creating related records (invoices, orders, etc.)
  • Syncing customer data to external systems

Team Scoped: Only returns customers belonging to the authenticated team. Attempting to access a customer from another team returns 404.

Header Parameters

x-client-idstring
x-signaturestring
Authorizationstring

Path Parameters

uuidstring Required

The unique identifier of the customer to retrieve. Must be a valid UUID v4 format.

Response

200
Object
Success - Customer found and returned

Response Attributes

statusstring
messagestring
dataobject

Show child attributes

400
Object
Bad Request - Invalid UUID format

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

401
Object
Unauthorized - Authentication failed

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

404
Object
Not Found - Customer does not exist

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

errorsarray

Present for validation errors with multiple fields

Show child attributes

429
Object
Too Many Requests - Rate limit exceeded

Response Attributes

statusstring Required

Always "error" for error responses

messagestring Required

Human-readable error description

codestring Required

Machine-readable error code for programmatic handling

detailsobject

Additional context about the error (varies by error type)

Show child attributes

errorsarray

Present for validation errors with multiple fields

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?