Skip to main content
GET
List application users

Query Parameters

pageSize
integer<uint32>
default:20

Items per page (max 1000)

Required range: 1 <= x <= 1000
isActive
boolean
accountType
enum<string>

Account type filter

Available options:
master,
sub
Minimum string length: 1
address
string
required

Wallet address

Minimum string length: 1
pageToken
string

Pagination cursor with two states:

  • Omitted or empty string (""): start a cursor walk with no prior position.
  • Non-empty: an opaque cursor from a previous response's nextPageToken; results resume immediately after that position.

Ordered by user id ascending, NOT newest-first: users.created_at is nullable, so it cannot be a total keyset key, and excluding the rows without one would hide users from the listing an application reconciles against.

total and totalPages are populated — bounded by the server count ceiling, see totalCapped.

Filters must match the request that produced the token, or the request is rejected 400.

clientId
string
required

Application client ID

Minimum string length: 1

Response

OK

users
object[] | null
total
integer<uint32> | null

Number of users matching the filter, bounded by the server ceiling — a lower bound when totalCapped is true.

Example:

50

pageSize
integer<uint32> | null

Items per page

Example:

20

totalPages
integer<uint32> | null

Number of pages at this pageSize, bounded by the server ceiling — a lower bound when totalCapped is true.

Example:

3

nextPageToken
string | null

Cursor for the next page, minted from the last row of an over-fetched page: this listing is one ordered read, so a page shorter than pageSize proves the walk is exhausted and this is empty.

totalCapped
boolean | null

True when more than the server ceiling of users matched, so the count stopped at the ceiling and total/totalPages are a lower bound.

Example:

false