Create User

post

https://api.work-engine.com/api/v1/companies/{company_id}/users

Creates a user.

Path Params

company_id

string

required

The unique identifier of the associated company.

Body Params

admin

boolean

Defaults to false

compensation_type

string

enum

Allowed:

employment_type

string

enum

Allowed:

employee_identifier

string | null

job_title

string

required

last_name

string

required

legal_first_name

string

required

middle_name

string

notifications

object

pay_period

string

enum

Allowed:

personal_email

string

required

phone

string

preferred_first_name

string

role

string

enum

Defaults to 0

Allowed:

salary_amount

integer

start_date

string

required

status

string

enum

Allowed:

supervisor_id

integer

user_external_identifier

string

work_email

string

Responses

401

Unauthorized

404

Not found

422

Unprocessable entity

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created