Skip to main content
GET
/
api
/
canary
/
customers
/
{id}
Gets the details for a single customer.

Path Parameters

id
string
required
The unique identifier of the customer

Response

Success
id
string
Unique identifier for the customer
merchantId
string
The merchant’s unique identifier
email
string
The customer’s email address
name
string
The customer’s full name
metadata
object
Custom metadata attached to the customer
createdAt
string
ISO 8601 timestamp when the customer was created
updatedAt
string
ISO 8601 timestamp when the customer was last updated

Example Response

{
  "id": "customer_789",
  "merchantId": "merchant_456",
  "email": "[email protected]",
  "name": "John Doe",
  "metadata": {
    "source": "web",
    "referralCode": "FRIEND123"
  },
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Error Responses

Unauthorized
Invalid or missing authentication token
Not Found
Customer not found
Internal Server Error
An unexpected error occurred on the server

Authentication

This endpoint requires Bearer token authentication.