Skip to main content
GET
List vendors with pagination

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Query Parameters

Search in vendor name and alias

isHidden
boolean

Filter by hidden status

commissionType
enum<string>

Filter by commission type

Available options:
percentage,
flat
first
integer

Number of items to return (forward pagination)

Required range: 1 <= x <= 100
after
string

Cursor for forward pagination

last
integer

Number of items to return (backward pagination)

Required range: 1 <= x <= 100
before
string

Cursor for backward pagination

Response

List of vendors

success
enum<boolean>
Available options:
true
data
object