Customers
API ReferenceCustomersList
List Customers
Retrieve a list of customers with optional filtering and pagination.
POST /customers/list
Body Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 10 | Number of customers to return (max: 100) |
offset | integer | No | 0 | Number of customers to skip |
email | string | No | — | Filter by email address |
created_gte | string | No | — | Filter customers created on or after this date |
created_lte | string | No | — | Filter customers created on or before this date |
Request Example
curl -X POST 'https://api.v2.paychtec.com/customers/list' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '{ "limit": 10, "offset": 0}'Response
{
"count": 2,
"total_count": 50,
"data": [
{
"customer_id": "cus_1234567890abcdef",
"email": "john@example.com",
"name": "John Doe",
"created": "2024-01-22T10:00:00Z"
},
{
"customer_id": "cus_0987654321fedcba",
"email": "jane@example.com",
"name": "Jane Smith",
"created": "2024-01-21T09:00:00Z"
}
]
}