Deputy

App · 20 actions

Read employees, locations, shifts, timesheets, leave and employment information.

Actions

ActionWhat it does
Get areaGet one area by its ID, returning its name, the location it belongs to and whether it is active.
Get employeeGet one employee by their ID, returning their name, contact details, main location and whether they are active.
Get employee agreementGet one employee agreement by its ID, returning the employee, pay rate details, contract and active dates.
Get employment contractGet one employment contract by its ID, returning its name, code and pay settings.
Get leave requestGet one leave request by its ID, returning the employee, leave dates, hours, type and approval status.
Get locationGet one location by its ID, returning its name, code, address and settings.
Get shiftGet one rostered shift by its ID, returning its employee, area, start and end times, breaks and whether it is published.
Get taskGet one task by its ID, returning its question, who it is assigned to, its due date and whether it is complete.
Get timesheetGet one timesheet by its ID, returning the employee, worked start and end times, breaks, total hours and approval state.
Get timesheet pay returnGet one timesheet pay return by its ID, returning its timesheet, pay rule, hours and cost.
List areasList the areas (operational units) shifts are rostered to, optionally only those changed since a given time.
List employee agreementsList employee agreements, which link an employee to their pay rates and contract, optionally only those changed since a given time.
List employeesList the employees in your Deputy account, optionally only those changed since a given time.
List employment contractsList employment contracts (award or pay templates), optionally only those changed since a given time.
List leave requestsList leave requests, optionally only those changed since a given time.
List locationsList your Deputy locations (workplaces), optionally only those changed since a given time.
List shiftsList rostered shifts, optionally only those changed since a given time.
List tasksList tasks assigned to staff, optionally only those changed since a given time.
List timesheet pay returnsList timesheet pay returns, the pay lines calculated from approved timesheets, optionally only those changed since a given time.
List timesheetsList 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

Areaarea_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

Employeeemployee_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 IDemployee_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 IDemployment_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 IDleave_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

Locationlocation_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 IDshift_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 IDtask_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 IDtimesheet_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 IDtimesheet_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_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

Startstartnumber
Start.At least 0.
Maxmaxnumber
Max.From 1 to 500.
Modified sincemodified_sincedate and time
Modified since.

Outputs

datalist
Response.
Example output
{
  "data": []
}

On this page