Skip to main content
GET
List accounts

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. Example: Authorization: Bearer sk_live_...

Query Parameters

type
enum<string>

Filter accounts by type. Can be combined with scope.

Available options:
collections,
payouts
scope
enum<string>

Filter accounts by shortcode scope. Use default for accounts where shortcodeId is absent, or shortcode for accounts where shortcodeId is present. Can be combined with type.

Available options:
default,
shortcode

Response

Accounts fetched successfully

status
string
required
Example:

"success"

message
string
required
Example:

"Accounts fetched"

data
object
required