latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Users

Retrieve detailed user profile

Overview

Fetch the complete profile of a specific user. This includes organizational details, active subscriptions (plans), and assigned access controls.

Use Cases

  • Profile Inspection: Verify the current configuration of a specific user.
  • Pre-Update Check: Retrieve the current state before performing a partial update.
  • Identity Verification: Confirm the email and name associated with a numerical ID.

Identification

The {userId} is a unique numerical identifier.

Getting User ID

  • To find users and their numerical IDs, use the Users Management API:

    • GET /public/v1/users - Retrieve all users with their id field.
  • The id field in the user response is the {userId} used in this endpoint's path parameter.

    Related Operations

    • Update Profile: PATCH /public/v1/users/{userId}
    • Manage Roles: POST /public/v1/users/{userId}/roles

Required Permission

access_public_users

get/public/v1/users/{userId}

Path parameters

userIdinteger required

The unique numerical identifier of the target user. If you do not have this ID, you can find it by searching for the user via GET /public/v1/users.

Response

User details retrieved successfully.

idinteger required
activeboolean required
confirmedboolean required
firstnamestring nullable
lastnamestring nullable
emailstring nullable