Skip to main content

Get API identity

GET /v1/public/me

Returns the merchant, integration, and scopes associated with the API key.

Authorization

X-API-Key required with the profile:read scope

Request example

curl -X GET "https://api.remyrewards.co.uk/v1/public/me" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Responses

StatusDescription
200API identity retrieved.
401The API key is missing or invalid.
403The API key is valid but does not have the required scope.
429A rate or concurrency limit was exceeded.

Success response example

{
"success": true,
"data": {
"merchant": {
"id": "66c735e253f2836fbe941230",
"name": "Example Coffee"
},
"integration": {
"id": "66c735e253f2836fbe941231",
"type": "zapier"
},
"scopes": [
"orders:read",
"vouchers:read"
]
}
}