GET/api/v2/loyalty/merchants

Get merchants with search, filtering, and pagination

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
search (query)stringNoOptional search term for merchant name
category (query)stringNoOptional filter by merchant category
isActive (query)booleanNoOptional filter by active status
isPartner (query)booleanNoOptional filter by partner status
limit (query)unknownNoMaximum number of merchants to return
offset (query)unknownNoNumber of merchants to skip

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Merchantsarray of MerchantResponseNo
PaginationPaginationResponseNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/loyalty/merchants" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.