Get customers
GET /v1/public/customers
Lists merchant-specific customer records. Use email for exact lookup or search for a case-insensitive name or email match.
Authorization
X-API-Key required with the customers:read scope
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
cursor | query | string | No | Opaque nextCursor returned by the previous list request. Do not construct or modify it. |
limit | query | integer | No | Maximum resources to return. |
email | query | string (email) | No | Filter by an exact email address. |
search | query | string | No | Search names and email addresses. |
Request example
curl -X GET "https://api.remyrewards.co.uk/v1/public/customers?limit=25" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"Responses
| Status | Description |
|---|---|
200 | Customers retrieved. |
400 | The request is missing a required value or contains invalid data. |
401 | The API key is missing or invalid. |
403 | The API key is valid but does not have the required scope. |
429 | A rate or concurrency limit was exceeded. |
Success response example
{
"success": true,
"data": [],
"pagination": {
"limit": 25,
"hasMore": false,
"nextCursor": null
}
}