Skip to main content
GET
List all customers

Authorizations

Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Query Parameters

limit
integer
default:10

Number of records to return per page

Required range: x >= 1
offset
integer
default:0

Number of records to skip

Required range: x >= 0
target_role
string

Comma-separated roles to filter by (case-insensitive)

provider_registration_status
string

Comma-separated provider registration statuses (case-insensitive)

provider
string

Comma-separated provider names (case-insensitive)

email
string

Comma-separated email addresses to filter by

document_type
string

Comma-separated document types (case-insensitive)

country_code
string

Comma-separated country codes (case-insensitive)

strict
boolean

Enforce limit restrictions

Response

200 - application/json

Customer list

msg
string
required

Human-readable message describing the result

data
object
required

Response payload (null on error)