Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
users

Returns a User object.

get/user

Query parameters

user_idstring uuid

The user ID of the user.

emailstring

The email of the user. If both user ID and email are provided, user ID will take precedence. If neither are provided, an error will occur.

Response

The user object associated with the passed-in email or ID.

user_idstring uuid required

The ID of the user.

emailstring required

The email of the user.

full_namestring required

The full name of the user.

first_namestring required

The first name of the user.

last_namestring required

The last name of the user.

positionstring required

The user's position.

hr_idp_status'ACTIVE' | 'SUSPENDED' | 'DEPROVISIONED' | 'DELETED' | 'NOT_FOUND'

User status pulled from an HR/IDP provider.

Example response

{
  "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
  "email": "john.doe@company.dev",
  "full_name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "position": "Engineer"
}