Get user list v2

The endpoint returns a list of users cursor-paginated.

SecuritybearerAuth
Request
query Parameters
id
string <uuid>

Unique user identifier in UUID format.

Example: id=8f3664a8-d98a-11ef-898b-02da11e44a70
type
string

Indicates the user type.

Enum: "retail" "business"
Example: type=retail
verified
boolean

Indicates if the user is verified.

Example: verified=true
active
boolean

Indicates if the user is active.

Example: active=true
trading_active
boolean

Indicates the user's trading active status.

Example: trading_active=true
registered_after
string <date-time>

Filters the users registered after a specific date. Value must be URL encoded.

Example: registered_after=2025-01-01T00%3A00%3A00%2B00%3A00
registered_before
string <date-time>

Filters the users registered before a specific date. Value must be URL encoded.

Example: registered_before=2025-01-01T00%3A00%3A00%2B00%3A00
size
integer [ 1 .. 100 ]

Indicates the number of results per page. Default value is 50 users per page.

Example: size=50
order
string

Allows results to be sorted in a specific order. Default value is "asc".

Enum: "asc" "desc"
after
string

Indicates the cursor value used for pagination.

Example: after=eyJ1c2Vycy5pZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ
Responses
200

List of users cursor-paginated with filtering options.

401

Unauthorized

422

Bad Request

503

Maintenance or Service unavailable

get/v2/users
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}