Skip to main content
GET
List sub-users

Authorizations

api-key
string
header
required

Your raw API key. Generate, rotate, and revoke keys from the merchant dashboard. Keys can optionally be bound to one or more allowed source IPs — requests from any other IP are rejected with API_KEY_IP_DENIED.

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:25
Required range: 1 <= x <= 100
status
enum<string>
Available options:
active,
suspended,
deleted
Required string length: 1 - 128
externalId
string
Required string length: 1 - 128

Response

OK.

requestId
string
required
success
boolean
required
data
object

Present when success: true. Shape varies per endpoint.

error
object