Users

Create user

POST https://{tenant}.atomicwork.com/api/v1/users

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Query Parameters

send_emailqueryboolean

Send welcome email or not

Body

first_namebodystring

middle_namebodystring

last_namebodystring

emailbodystring

personal_emailbodystring

timezonebodystring

languagebodystring

departmentbodyinteger

teambodyinteger

levelbodystring

titlebodystring

addressbodystring

originally_hiredbodystring

joined_onbodystring

terminated_onbodystring

employee_idbodystring

date_of_birthbodystring

phone_numberbodystring

genderbodystring

statebodystring

citybodystring

countrybodystring

hrbodyinteger

managerbodyinteger

is_deletedbodyboolean

deleted_atbodystring

employment_statusbodystring

slack_idbodystring

azure_idbodystring

external_idbodystring

external_app_typebodyenum (string)

Allowed valuesMICROSOFTOKTAGOOGLERAPID7JUMPCLOUD

org_rolesbodyarray of integer

passwordbodystring

profile_imagebodyinteger

custom_fieldsbodyobject

has_reportersbodyboolean

typebodyenum (string)

Allowed valuesEMPLOYEEEXTERNALAI_EMPLOYEE

workspacesbodyarray of object

properties

notification_enabledbodyboolean

Response

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/users' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"first_name": "string", "middle_name": "string", "last_name": "string", "email": "email", "personal_email": "email", "timezone": "string", "language": "string", "department": 0, "team": 0, "level": "string", "title": "string", "address": "string", "originally_hired": "date", "joined_on": "date", "terminated_on": "date", "employee_id": "string", "date_of_birth": "date", "phone_number": "string", "gender": "string", "state": "string", "city": "string", "country": "string", "hr": 0, "manager": 0, "is_deleted": true, "deleted_at": "date-time", "employment_status": "string", "slack_id": "string", "azure_id": "string", "external_id": "string", "external_app_type": "MICROSOFT", "org_roles": [0], "password": "string", "profile_image": 0, "custom_fields": {}, "has_reporters": true, "type": "EMPLOYEE", "workspaces": [{"id": 0, "roles": ["\u2026"]}], "notification_enabled": true}'