List customers
Retrieve a paginated list of customers for the merchant
Related endpoints
GET /customers/{customerId}/invoices— List customer invoicesGET /customers/{customerId}/subscriptions— List customer subscriptionsGET /customers/{customerId}/orders— List customer ordersGET /customers/{customerId}/payments— List customer paymentsPUT /customers/external/batch— Batch upsert customers by external IDPOST /customers— Create a new customerGET /customers/{id}— Get customer by IDPATCH /customers/{id}— Update customer details
Common errors
401 unauthenticated— missing, malformed, or revoked API key.
Pagination
Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.
x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Query Parameters
limit?integer
Maximum number of results (1-100)
Default
20Range
1 <= value <= 100offset?|
Number of results to skip
Default
0Range
0 <= valuesearch?string
Search term to filter customers
Response Body
application/json
application/json
Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/customers" \
-H "x-api-key: $REVKEEN_API_KEY"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
"merchant_ref_id": "string",
"email": "user@example.com",
"name": "string",
"phone": "string",
"company_name": "string",
"address_line1": "string",
"address_line2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"auth_user_id": "990d439e-9996-4264-8929-f50029888dd9",
"metadata": {},
"custom_fields": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"limit": 0,
"offset": 0,
"total": 0
}
}{
"error": "Unauthorized"
}