v1

latestOpenAPI 3.1.02026-07-14801408.6 KB

/employees

Creates an employee for your account. Required scope: w_employees.

post/employees

Path parameters

subdomainstring required

The account subdomain

Request body

member_idstring

Optional value, this can be retrieved by GET /members endpoint

Response

201

idstring

firstnamestring

lastnamestring

emailstring

start_datestring

statestring

employee_numberstring

{"stackTrail":"paths:/employees:post:responses:201:content:application/json:schema:properties:avatar","oasType":"schema","type":"unknown"}

phonestring

job_titlestring

manager_idstring

department_idstring

{"stackTrail":"paths:/employees:post:responses:201:content:application/json:schema:properties:template_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/employees:post:responses:201:content:application/json:schema:properties:division_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/employees:post:responses:201:content:application/json:schema:properties:candidate_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/employees:post:responses:201:content:application/json:schema:properties:roles","oasType":"schema","type":"unknown"}

legal_entity_idstring

work_schedule_idstring

work_emailstring

{"stackTrail":"paths:/employees:post:responses:201:content:application/json:schema:properties:address","oasType":"schema","type":"unknown"}

Example response

{
  "id": "375b",
  "firstname": "Zinedin",
  "lastname": "Doe",
  "email": "zinedin_doe@gmail.com",
  "start_date": "2021-10-08T00:00:00.000Z",
  "state": "draft",
  "employee_number": "80",
  "phone": "+18579909723",
  "job_title": "Account Manager ",
  "manager_id": "2fce",
  "department_id": "3ff4d641",
  "legal_entity_id": "e697173f-5853-48c0-8eb4-b9c67ca11a93",
  "work_schedule_id": "5c6",
  "work_email": "zinedin_doe@sampleemployee.com"
}