Skip to main content
GET
/
api
/
canary
/
customers
Retrieves a paginated list of all customers for the merchant.

​
Query Parameters

​
search
string
Search customers by name or email
​
email
string
Filter customers by exact email address
​
offset
number
Number of customers to skip (default: 0)
​
limit
number
Maximum number of customers to return (default: 50, max: 100)

​
Response

​
Success
​
data
array
Array of customers
​
pagination
object
Pagination information

​
Example Response

{
  "data": [
    {
      "id": "customer_789",
      "merchantId": "merchant_456",
      "email": "[email protected]",
      "name": "John Doe",
      "metadata": {
        "source": "web"
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 150,
    "hasMore": true
  }
}

​
Error Responses

​
Unauthorized
Invalid or missing authentication token
​
Internal Server Error
An unexpected error occurred on the server

​
Authentication

This endpoint requires Bearer token authentication.