Sync staff and leave
Send staff and leave between Imploy and your payroll or HR system.
Use this guide to keep a payroll or HR system and Imploy matched on who works for you and who is on leave.
Token permissions: Staff Read to pull, Staff Read-write to create, update or approve leave. Roster Read for availability.
Pull staff
GET /staff takes per_page, page, updated_since and status. Paging and checkpoints work the same as in Sync clients.
A staff member has id, first_name, last_name, email, phone and status. Status is one of Active, Inactive, Pending, Non-compliant or Archived. Suppliers are not included.
Create staff
Use GET /staff/create-options to see what the Add staff form needs, then POST /staff or POST /staff/bulk (up to 50). Creating a staff member needs first_name, last_name and email.
Email changes are not supported through the API. Match staff on the Imploy id, not on email.
DELETE /staff/{id} archives a staff member. It doesn't remove the record.
Work with leave
| Task | Call |
|---|---|
| List leave in a period | GET /leave (returns leave overlapping the period) |
| Add leave | POST /leave |
| Edit a request | PATCH /leave/{id} |
| Approve or decline | POST /leave/{id}/status |
| Delete a request | DELETE /leave/{id} |
A common flow: your HR system approves leave, then pushes it to Imploy with POST /leave. Shift creation checks leave, so cover is flagged before a shift is booked on top of it.
Find who is free
GET /staff/available finds staff free to work a shift. It needs Roster Read. Use it before assigning a shift. See Push shifts into the roster.