Users

List users

Report an API docs issue

Returns all users you have access to with profile information. Results are filtered by your account permissions — you'll see yourself and any users connected to you via partnerships.

GET
/
users

Autorisations

Authorizationstringheaderrequired

API tokens can be created in the Dashboard settings. Requires an Ultra subscription.

Paramètres de requête

limitintegerquery

Number of records to return (default 50, max 100)

Required range: 1 ≤ x ≤ 100

Default: 50

Example: 50

offsetintegerquery

Number of records to skip (default 0)

Required range: x ≥ 0

Default: 0

Example: 0

Réponse

200application/json

List of users

okbooleanrequired
dataobjectrequired
Show child attributes
dataobject[]required
Show child attributes
idinteger

Internal user ID

usernamestring | null

User's unique username (from profile)

accountTypeenum

Account type

Allowed values: usersupportadminsuperadmin

subscriptionTierenum | null

Subscription tier (null if no subscription)

Allowed values: ultrapioneerfounderemployee

leagueinteger

Current league tier

rankinteger

Leaderboard rank

totalPointsinteger

Lifetime points earned

matchPointsinteger

Points in current match period

profileImagestring | null

URL to user's profile image

profileDescriptionstring | null

User's profile bio/description

profileTitlestring | null

User's profile title

paginationobjectrequired
Show child attributes
limitintegerrequired

Number of records returned

Example: 50

offsetintegerrequired

Number of records skipped

Example: 0

401application/json

Authentication required or token invalid

okbooleanrequired
errorstringrequired
500application/json

Internal server error

okbooleanrequired
errorstringrequired