Sign in

v2

latestOpenAPI 3.0.02026-07-31172752.6 KB
users

Get a user by ID

Returns a single user in your organization by their ID.

get/api/v1/users/{id}

Path parameters

idstring required

User ID

Response

User

deactivated_atstring date-time nullable

Deactivation timestamp

departmentsstring[]

Departments the user belongs to

emailstring email required

Email address

employment_type'full_time' | 'part_time' | 'contract' | 'freelance' | 'internship' | 'apprenticeship' | 'working_student' | 'training' nullable

Employment type

first_namestring required

First name

full_namestring

Full name (computed)

idstring uuid required

User ID

inserted_atstring date-time

Creation timestamp

job_titlestring nullable

Job title

last_namestring required

Last name

location_citystring nullable

City location

manager_user_idstring uuid nullable

Manager user ID

status'active' | 'inactive' | 'onboarding' | 'onboarding_provisioning_planned' | 'offboarding' | 'offboarding_planned' | 'offboarded' required

Current status

teamsstring[]

Teams the user belongs to

updated_atstring date-time

Last update timestamp

Example response

{
  "deactivated_at": null,
  "departments": [
    "Engineering"
  ],
  "email": "john@example.com",
  "employment_type": "full_time",
  "first_name": "John",
  "full_name": "John Doe",
  "id": "7488a646-e31f-11e4-aace-600308960662",
  "inserted_at": "2023-01-01T00:00:00Z",
  "job_title": "Software Engineer",
  "last_name": "Doe",
  "location_city": "San Francisco",
  "manager_user_id": null,
  "status": "active",
  "teams": [
    "Engineering",
    "Backend"
  ],
  "updated_at": "2023-01-01T00:00:00Z"
}