Skip to main content
GET
List merchants

Authorizations

Authorization
string
header
required

API token issued from the Equated app under Settings → API Tokens.

Query Parameters

from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
to
string
Pattern: ^\d{4}-\d{2}-\d{2}$
sort
enum<string>
Available options:
amount,
date
direction
enum<string>
Available options:
asc,
desc
role
enum<string>
Available options:
vendor,
customer,
all
limit
integer
Required range: 0 < x <= 200
offset
integer | null
Required range: x >= 0

Response

200 - application/json

Merchants with aggregates

merchants
object[]
required