WOworkable

/employees

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

post/employees

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/employees
  • Auth
    API key in header Authorization

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
avatarunknown
phonestring
job_titlestring
manager_idstring
department_idstring
template_idunknown
division_idunknown
candidate_idunknown
rolesunknown
legal_entity_idstring
work_schedule_idstring
work_emailstring
addressunknown

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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.