List users
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.
Authorizations
AuthorizationstringheaderrequiredAPI tokens can be created in the Dashboard settings. Requires an Ultra subscription.
Query Parameters
limitintegerqueryNumber of records to return (default 50, max 100)
Required range: 1 ≤ x ≤ 100
Default: 50
Example: 50
offsetintegerqueryNumber of records to skip (default 0)
Required range: x ≥ 0
Default: 0
Example: 0
Response
200application/jsonList of users
List of users
okbooleanrequireddataobjectrequiredShow child attributes
dataobject[]requiredShow child attributes
idintegerInternal user ID
usernamestring | nullUser's unique username (from profile)
accountTypeenumAccount type
Allowed values: usersupportadminsuperadmin
subscriptionTierenum | nullSubscription tier (null if no subscription)
Allowed values: ultrapioneerfounderemployee
leagueintegerCurrent league tier
rankintegerLeaderboard rank
totalPointsintegerLifetime points earned
matchPointsintegerPoints in current match period
profileImagestring | nullURL to user's profile image
profileDescriptionstring | nullUser's profile bio/description
profileTitlestring | nullUser's profile title
paginationobjectrequiredShow child attributes
limitintegerrequiredNumber of records returned
Example: 50
offsetintegerrequiredNumber of records skipped
Example: 0
401application/jsonAuthentication required or token invalid
Authentication required or token invalid
okbooleanrequirederrorstringrequired500application/jsonInternal server error
Internal server error
okbooleanrequirederrorstringrequired