Deputy
App · 20 actions
Read employees, locations, shifts, timesheets, leave and employment information.
Actions
| Action | What it does |
|---|---|
| Get area | Get one area by its ID, returning its name, the location it belongs to and whether it is active. |
| Get employee | Get one employee by their ID, returning their name, contact details, main location and whether they are active. |
| Get employee agreement | Get one employee agreement by its ID, returning the employee, pay rate details, contract and active dates. |
| Get employment contract | Get one employment contract by its ID, returning its name, code and pay settings. |
| Get leave request | Get one leave request by its ID, returning the employee, leave dates, hours, type and approval status. |
| Get location | Get one location by its ID, returning its name, code, address and settings. |
| Get shift | Get one rostered shift by its ID, returning its employee, area, start and end times, breaks and whether it is published. |
| Get task | Get one task by its ID, returning its question, who it is assigned to, its due date and whether it is complete. |
| Get timesheet | Get one timesheet by its ID, returning the employee, worked start and end times, breaks, total hours and approval state. |
| Get timesheet pay return | Get one timesheet pay return by its ID, returning its timesheet, pay rule, hours and cost. |
| List areas | List the areas (operational units) shifts are rostered to, optionally only those changed since a given time. |
| List employee agreements | List employee agreements, which link an employee to their pay rates and contract, optionally only those changed since a given time. |
| List employees | List the employees in your Deputy account, optionally only those changed since a given time. |
| List employment contracts | List employment contracts (award or pay templates), optionally only those changed since a given time. |
| List leave requests | List leave requests, optionally only those changed since a given time. |
| List locations | List your Deputy locations (workplaces), optionally only those changed since a given time. |
| List shifts | List rostered shifts, optionally only those changed since a given time. |
| List tasks | List tasks assigned to staff, optionally only those changed since a given time. |
| List timesheet pay returns | List timesheet pay returns, the pay lines calculated from approved timesheets, optionally only those changed since a given time. |
| List timesheets | List timesheets, optionally only those changed since a given time. |
Get area
Get one area by its ID, returning its name, the location it belongs to and whether it is active.
Inputs
- Area
area_idnumberRequired - Area ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get employee
Get one employee by their ID, returning their name, contact details, main location and whether they are active.
Inputs
- Employee
employee_idnumberRequired - Employee ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get employee agreement
Get one employee agreement by its ID, returning the employee, pay rate details, contract and active dates.
Inputs
- Employee agreement ID
employee_agreement_idnumberRequired - Employee agreement ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get employment contract
Get one employment contract by its ID, returning its name, code and pay settings.
Inputs
- Employment contract ID
employment_contract_idnumberRequired - Employment contract ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get leave request
Get one leave request by its ID, returning the employee, leave dates, hours, type and approval status.
Inputs
- Leave request ID
leave_request_idnumberRequired - Leave request ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get location
Get one location by its ID, returning its name, code, address and settings.
Inputs
- Location
location_idnumberRequired - Location ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get shift
Get one rostered shift by its ID, returning its employee, area, start and end times, breaks and whether it is published.
Inputs
- Shift ID
shift_idnumberRequired - Shift ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get task
Get one task by its ID, returning its question, who it is assigned to, its due date and whether it is complete.
Inputs
- Task ID
task_idnumberRequired - Task ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get timesheet
Get one timesheet by its ID, returning the employee, worked start and end times, breaks, total hours and approval state.
Inputs
- Timesheet ID
timesheet_idnumberRequired - Timesheet ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get timesheet pay return
Get one timesheet pay return by its ID, returning its timesheet, pay rule, hours and cost.
Inputs
- Timesheet pay return ID
timesheet_pay_return_idnumberRequired - Timesheet pay return ID.At least 1.
Outputs
dataobject- Response.
Example output
{
"data": {}
}List areas
List the areas (operational units) shifts are rostered to, optionally only those changed since a given time. Returns one page; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List employee agreements
List employee agreements, which link an employee to their pay rates and contract, optionally only those changed since a given time. Returns one page; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List employees
List the employees in your Deputy account, optionally only those changed since a given time. Returns one page; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List employment contracts
List employment contracts (award or pay templates), optionally only those changed since a given time. Returns one page; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List leave requests
List leave requests, optionally only those changed since a given time. Returns one page with each request's employee, dates and status; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List locations
List your Deputy locations (workplaces), optionally only those changed since a given time. Returns one page; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List shifts
List rostered shifts, optionally only those changed since a given time. Returns one page with each shift's employee, area, start and end; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List tasks
List tasks assigned to staff, optionally only those changed since a given time. Returns one page with each task's question, assignee and due date; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List timesheet pay returns
List timesheet pay returns, the pay lines calculated from approved timesheets, optionally only those changed since a given time. Returns one page; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}List timesheets
List timesheets, optionally only those changed since a given time. Returns one page with each timesheet's employee, times and approval state; use start and max for the next page.
Inputs
- Start
startnumber - Start.At least 0.
- Max
maxnumber - Max.From 1 to 500.
- Modified since
modified_sincedate and time - Modified since.
Outputs
datalist- Response.
Example output
{
"data": []
}