List Customers

GET/v1/customersRecommended

List customers with keyset pagination and optional email/phone filters.

Authentication

Signature Pattern

HMAC-SHA256(secretKey, "{timestamp}\nGET\n/v1/customers\n{sha256(\"\")}")

Header	Value	Description
`X-Api-Key`	pk_live_a1b2c3d4e5f6g7h8	Merchant public API key
`X-Signature`	{hmac_sha256_hex}	Hex HMAC-SHA256 request signature
`X-Timestamp`	2026-04-13T10:00:00Z	ISO 8601 UTC request time (±5 min)

Request Parameters

Name	Type	Required	Description
`email`	string	Optional	Filter by email
`phone`	string	Optional	Filter by phone
`limit`	integer	Optional	Page size
`cursor`	string	Optional	Opaque keyset cursor from a prior page

Response Parameters

Field	Type	Example
`items`	array	[…]
`items[].id`	string	"cus_a1b2c3d4e5f6"
`items[].externalId`	string	"CUST-4821"
`items[].email`	string	"buyer@example.com"
`items[].name`	string	"Ayşe Yılmaz"
`items[].createdAt`	string	"2026-04-13T10:00:00Z"
`nextCursor`	string	"eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTEzVDEwOjAw…

Response Example

JSONResponse

{
  "items": [
    {
      "id": "cus_a1b2c3d4e5f6",
      "externalId": "CUST-4821",
      "email": "buyer@example.com",
      "name": "Ayşe Yılmaz",
      "createdAt": "2026-04-13T10:00:00Z"
    }
  ],
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTEzVDEwOjAwOjAwWiJ9"
}

Status Codes

200Success

201Created

400Bad Request

401Unauthorized

404Not Found

429Rate Limited

Try itMock

GEThttps://api.pay.sandbox.kvell.group

← Update Customer Delete Customer→