DashboardApiEndpoints

Users

List and retrieve user information

List Users

GET /api/v1/users

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

number

Number of records to return (max 100).

number

Number of records to skip for pagination.

okbooleanrequired

Always true on success.

data.dataobject[]required

Array of user objects with profile information.

idnumber

The user's internal ID.

usernamestring

The user's unique username (from profile).

accountTypestring

One of user, support, admin, or superadmin.

subscriptionTierstring

Subscription tier: ultra, pioneer, founder, employee, or null if no subscription.

leaguenumber

The user's current league tier.

ranknumber

The user's leaderboard rank.

totalPointsnumber

Lifetime points earned.

matchPointsnumber

Points earned in the current match period.

profileImagestring

URL to the user's profile image (nullable).

profileDescriptionstring

User's profile bio/description (nullable).

profileTitlestring

User's profile title (nullable).

data.paginationobjectrequired

Pagination metadata.

limitnumber

Number of records returned.

offsetnumber

Number of records skipped.

curl -H "Authorization: Bearer YOUR_TOKEN" \
  "https://dashboard.researchanddesire.com/api/v1/users?limit=50&offset=0"
{
  "ok": true,
  "data": {
    "data": [
      {
        "id": 42,
        "username": "alice_trainer",
        "accountType": "user",
        "subscriptionTier": "ultra",
        "league": 3,
        "rank": 150,
        "totalPoints": 12500,
        "matchPoints": 800,
        "profileImage": "https://example.com/avatar.jpg",
        "profileDescription": "Hello world",
        "profileTitle": "Expert Trainer"
      }
    ],
    "pagination": {
      "limit": 50,
      "offset": 0
    }
  }
}

Get User by ID

GET /api/v1/users/{id}

Returns detailed information about a specific user, including their profile data. You can only access users you have a connection with.

numberrequired

The user's internal ID.

dataobjectrequired

User object with extended fields.

idnumber

The user's internal ID.

usernamestring

The user's unique username.

accountTypestring

Account type.

subscriptionTierstring

Subscription tier.

totalPointsnumber

Lifetime points earned.

matchPointsnumber

Points earned in the current match period.

Profileobject

The user's public profile, if accessible.

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://dashboard.researchanddesire.com/api/v1/users/42
{
  "ok": true,
  "data": {
    "id": 42,
    "username": "alice_trainer",
    "accountType": "user",
    "subscriptionTier": "ultra",
    "league": 3,
    "rank": 150,
    "totalPoints": 12500,
    "matchPoints": 800,
    "profileImage": "https://example.com/avatar.jpg",
    "profileDescription": "Hello world",
    "profileTitle": "Expert Trainer"
  }
}
{
  "ok": false,
  "error": "User not found"
}

On this page