Raad Guides
API Reference

Users

1 endpoint

Overview

The Users resource represents your authenticated API user. Use it to retrieve profile information for the currently authenticated user.

GET /api/v1/users/{id} Requires Auth

Retrieve a user by ID.

Parameters

Name In Type Required Description
id path uuid Yes The user's UUID

Responses

200 User found
Response
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "user",
    "attributes": {
      "email": "user@example.com",
      "role": "client",
      "accountRole": "owner",
      "shortName": "JS",
      "firstName": "Jane",
      "lastName": "Smith",
      "fullName": "Jane Smith",
      "niceName": "Jane Smith",
      "primaryColor": "#4A90E2",
      "secondaryColor": "#50C878",
      "totalPoints": 0,
      "pilotProfileCompleted": false,
      "clientProfileCompleted": true,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-03-01T14:22:00.000Z"
    }
  }
}
404 User not found

User Object

The User object contains the following attributes:

Attribute Type Description
id uuid Unique identifier
email string Email address
role string User role (client, pilot, admin)
accountRole string Role within the account
shortName string Initials or short display name
firstName string First name
lastName string Last name
fullName string Full display name
primaryColor string Hex color for UI theming
secondaryColor string Secondary hex color for UI theming
totalPoints integer Gamification points
clientProfileCompleted boolean Whether client profile is complete
createdAt datetime ISO 8601 creation timestamp
updatedAt datetime ISO 8601 last updated timestamp