RevKeen Docs
Api reference

List customers

Retrieve a paginated list of customers for the merchant


Related endpoints

  • GET /customers/{customerId}/invoices — List customer invoices
  • GET /customers/{customerId}/subscriptions — List customer subscriptions
  • GET /customers/{customerId}/orders — List customer orders
  • GET /customers/{customerId}/payments — List customer payments
  • PUT /customers/external/batch — Batch upsert customers by external ID
  • POST /customers — Create a new customer
  • GET /customers/{id} — Get customer by ID
  • PATCH /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.

GET
/customers
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)

Default20
Range1 <= value <= 100
offset?|

Number of results to skip

Default0
Range0 <= value
search?string

Search term to filter customers

Response Body

application/json

curl "https://api.revkeen.com/v2/customers" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
      "merchantRefId": "string",
      "email": "user@example.com",
      "name": "string",
      "phone": "string",
      "authUserId": "5a3cace6-919f-4109-8313-c3a2264a4134",
      "metadata": {},
      "customFields": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}
Empty