Invite

Get invitees

Get paginated list of users invited by an account, with volume data.

get/v1/invite/invitees/{account}

Request

Base URL
https://api.testnet.rise.trade
Auth
none required
TypeScript
https://skmtc.dev/rise/apis/risex-rest-api/docs/v1/invite/invitees/:account/get.ts
A function with typed inputs. Its response is checked against the schema.

accountstring required

limitinteger

Pagination: items per page (default 50, max 200)

pageinteger

Pagination: 1-indexed page number (default 1)

statusstring

Optional filter by account status: PENDING, ACTIVE, EXPIRED, SUSPENDED

sort_direction'DESC' | 'ASC'

Sort direction (default DESC). Applies to whichever field sort_by selects.

addressstring

Optional filter by invitee address (hex substring, case-insensitive, with or without 0x)

codestring

Optional filter by invite code the invitee redeemed (case-insensitive substring)

sort_by'INVITEE_SORT_BY_UNSPECIFIED' | 'INVITEE_SORT_BY_CREATED_AT' | 'INVITEE_SORT_BY_VOLUME'

Sort field (default CREATED_AT)

A successful response.

totalinteger