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
Path Parameters
The unique identifier of the customer to retrieve. Must be a valid UUID v4 format.
Response
Response Attributes
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Present for validation errors with multiple fields
Show child attributes
Response Attributes
Always "error" for error responses
Human-readable error description
Machine-readable error code for programmatic handling
Additional context about the error (varies by error type)
Show child attributes
Present for validation errors with multiple fields