Sign in

v7

latestOpenAPI 3.1.02026-08-07154197463.6 KB
users

Returns the user that the provided API token authenticates as.

get/users/whoami

Response

The user that the API token authenticates as.

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"
}