People & HR

For how this area works day to day, see the People & HR guide.

Webhook events: employee.created, employee.updated, employee.transferred, employee.terminated, employee.archived, pay_rate.changed, document.expiring Planned, certification.expiring Planned. See Webhooks.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

• GET/employees

  List employees

  Keypeople:read

  Peopleemployees.read

  Featurepeople
• POST/employees

  Create an employee

  Keypeople:write

  Peopleemployees.write

  Featurepeople
• GET/employees/external/{externalId}

  Get an employee by external ID

  Keypeople:read

  Peopleemployees.read

  Featurepeople
• PUT/employees/external/{externalId}

  Create or replace an employee by external ID

  Keypeople:write

  Peopleemployees.write

  Featurepeople
• GET/employees/{employeeId}/documents

  List employee documents

  Keypeople:read

  Peopledocuments.read

  Featurepeople.documents
• POST/employees/{employeeId}/documents

  Create an employee document

  Keypeople:write

  Peopledocuments.manage

  Featurepeople.documents
• GET/employees/{employeeId}/documents/{id}

  Get an employee document

  Keypeople:read

  Peopledocuments.read

  Featurepeople.documents
• PATCH/employees/{employeeId}/documents/{id}

  Update an employee document (partial)

  Keypeople:write

  Peopledocuments.manage

  Featurepeople.documents
• DELETE/employees/{employeeId}/documents/{id}

  Archive an employee document

  Keypeople:write

  Peopledocuments.manage

  Featurepeople.documents
• GET/employees/{id}

  Get an employee

  Keypeople:read

  Peopleemployees.read

  Featurepeople
• PATCH/employees/{id}

  Update an employee (partial)

  Keypeople:write

  Peopleemployees.write

  Featurepeople
• DELETE/employees/{id}

  Archive an employee

  Keypeople:write

  Peopleemployees.write

  Featurepeople
• GET/employees/{id}/pay-rates

  Pay rate history (newest first)

  Keypayroll:read

  Peoplepay.read

  Featurepeople
• POST/employees/{id}/pay-rates

  Add a pay rate

  Keypayroll:write

  Peoplepay.write

  Featurepeople
• GET/employees/{id}/skills

  An employee's skills and certifications

  Keypeople:read

  Peopleemployees.read

  Featurepeople.skills
• PUT/employees/{id}/skills/{skillId}

  Give an employee a skill or certification

  Keypeople:write

  Peopleskills.manage

  Featurepeople.skills
• DELETE/employees/{id}/skills/{skillId}

  Remove a skill from an employee

  Keypeople:write

  Peopleskills.manage

  Featurepeople.skills
• POST/employees/{id}:rehire

  Rehire a terminated employee

  Keypeople:write

  Peopleemployees.write

  Featurepeople
• POST/employees/{id}:terminate

  Terminate an employee

  Keypeople:write

  Peopleemployees.write

  Featurepeople
• POST/employees/{id}:transfer

  Transfer an employee (location, department, position or manager)

  Keypeople:write

  Peopleemployees.write

  Featurepeople
• GET/payslips

  List payslips

  Keypayroll:read

  Peoplepay.read

  Featureemployee_area.payslips
• POST/payslips

  Send payslips from your payroll provider

  Keypayroll:write

  People—not allowed

  Featureemployee_area.payslips
• GET/skills

  List skills

  Keypeople:read

  Peopleemployees.read

  Featurepeople.skills
• POST/skills

  Create a skill

  Keypeople:write

  Peopleskills.manage

  Featurepeople.skills
• GET/skills/external/{externalId}

  Get a skill by external ID

  Keypeople:read

  Peopleemployees.read

  Featurepeople.skills
• PUT/skills/external/{externalId}

  Create or replace a skill by external ID

  Keypeople:write

  Peopleskills.manage

  Featurepeople.skills
• GET/skills/{id}

  Get a skill

  Keypeople:read

  Peopleemployees.read

  Featurepeople.skills
• PATCH/skills/{id}

  Update a skill (partial)

  Keypeople:write

  Peopleskills.manage

  Featurepeople.skills
• DELETE/skills/{id}

  Archive a skill

  Keypeople:write

  Peopleskills.manage

  Featurepeople.skills