v1

latestOpenAPI 3.1.02026-08-04147764567.0 KB

users

Create user

post/api/v1/users

Query parameters

send_emailboolean

Send welcome email or not

Headers

X-Api-Keystring required

X-Workspace-Idstring

Request body

first_namestring

middle_namestring

last_namestring

emailstring email

personal_emailstring email

timezonestring

languagestring

departmentinteger

teaminteger

levelstring

titlestring

addressstring

originally_hiredstring date

joined_onstring date

terminated_onstring date

employee_idstring

date_of_birthstring date

phone_numberstring

genderstring

statestring

citystring

countrystring

hrinteger

managerinteger

is_deletedboolean

deleted_atstring date-time

employment_statusstring

slack_idstring

azure_idstring

external_idstring

external_app_type'MICROSOFT' | 'OKTA' | 'GOOGLE' | 'RAPID7' | 'JUMPCLOUD'

org_rolesinteger[]

passwordstring

profile_imageinteger

custom_fieldsApiV1UsersPostRequestBodyContentApplicationJsonSchemaCustomFields

has_reportersboolean

type'EMPLOYEE' | 'EXTERNAL' | 'AI_EMPLOYEE'

notification_enabledboolean

Response

Successful response

UsersPostapiV1UsersResponse200 required

Empty response body