Skip to main content
GET
List merchants

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version
enum<string>
required
Available options:
2026-04-01

Query Parameters

external_id
string[]

Return only merchants with these external ids, comma-separated

Example:

"acct_492"

include_archived
boolean
required

Include archived merchants, which are excluded by default

limit
integer<int64>
required

Merchants to return per page

Example:

20

offset
integer<int64>
required

Merchants to skip before the first returned

Example:

0

sort
string
required

Sort field and direction in format field:order. Sortable fields: display_name, external_id, support_email, created_at

Example:

"display_name:asc"

Response

Success

data
object[]
required

List of merchants

pagination
object
required

Pagination metadata