👤 User APIs_

Overview

The User APIs provide access to public user profile information and achievements. All endpoints respect user privacy settings and only return data for users with public profiles.

Endpoints

Get Public User Profile

Endpoint: GET /users/public/{userId}

Retrieves public information about a user profile. Only works for users with public profiles.

Parameters:

• userId (path) - The user's ID

Response:

<code>{
  &quot;success&quot;: true,
  &quot;user&quot;: {
    &quot;id&quot;: 123,
    &quot;name&quot;: &quot;John Doe&quot;,
    &quot;avatar_url&quot;: &quot;https://example.com/avatar.jpg&quot;,
    &quot;company&quot;: {
      &quot;id&quot;: 456,
      &quot;name&quot;: &quot;Example Company&quot;,
      &quot;role&quot;: &quot;Driver&quot;
    },
    &quot;roles&quot;: [
      {
        &quot;id&quot;: 1,
        &quot;name&quot;: &quot;Member&quot;,
        &quot;hierarchy&quot;: 1
      }
    ],
    &quot;created_at&quot;: &quot;2023-01-01T00:00:00Z&quot;
  }
}
</code>

Error Responses:

• 404 - User not found
• 403 - Profile is private

Get User Achievements

Endpoint: GET /users/{userId}/achievements

Retrieves all achievements unlocked by a specific user. Only works for users with public profiles.

Parameters:

• userId (path) - The user's ID

Response:

<code>{
  &quot;success&quot;: true,
  &quot;achievements&quot;: [
    {
      &quot;achievement&quot;: {
        &quot;id&quot;: 1,
        &quot;name&quot;: &quot;First Steps&quot;,
        &quot;description&quot;: &quot;Complete your first drive&quot;,
        &quot;icon&quot;: &quot;first_steps.png&quot;,
        &quot;type&quot;: &quot;driving&quot;,
        &quot;tier&quot;: 1,
        &quot;points&quot;: 10
      },
      &quot;tier&quot;: 1,
      &quot;unlocked_at&quot;: &quot;2023-01-01T00:00:00Z&quot;
    }
  ]
}
</code>

Error Responses:

• 404 - User not found
• 403 - Profile is private

← Back to API Documentation