Skip to main content
GET
List merchants

Authorizations

x-api-key
string
header
required

Company API key for authentication

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
limit
integer
default:20

Number of merchants per page

Required range: 1 <= x <= 100
status
enum<string>[]

Comma-separated list of statuses to filter by (e.g., inactive,blocked)

Available options:
pending_activation,
active,
inactive,
blocked
created_at_from
string<date-time>

Filter merchants created from this date (ISO 8601 format)

created_at_to
string<date-time>

Filter merchants created up to this date (ISO 8601 format)

document_type
enum<string>

Filter by document type

Available options:
cpf,
cnpj
document_number
string

Filter by document number (exact match)

name
string

Filter by merchant name (partial start match, case insensitive)

full_name
string

Filter by merchant full name (partial start match, case insensitive)

sort
enum<string>[]

Sort order (prefix with - for descending). Multiple fields separated by comma

Available options:
created_at,
name,
full_name,
-created_at,
-name,
-full_name

Response

Paginated list of merchants

data
object[]
pagination
object