Skip to main content

Get customer by ID

GET 

/api/v1/customers/:customerId

This endpoint retrieves customer information by their unique customer ID.

Authentication: Requires a Private API Key (sk_*) passed in the X-API-Key header.

Use Cases:

  • Fetching customer details after obtaining customer ID from other endpoints
  • Direct customer lookup when ID is already known
  • Customer profile synchronization
  • Order history and analytics

Error Scenarios:

  • 404 NOT FOUND: Customer with this ID doesn't exist (Error code: CUSTOMER_NOT_FOUND)
  • 400 BAD REQUEST: Invalid customer ID format (Error code: INVALID_CUSTOMER_ID)
  • 401 UNAUTHORIZED: Invalid or missing API key (Error code: INVALID_API_KEY)
  • 403 FORBIDDEN: API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Customer found and returned successfully