v1

latestOpenAPI 3.1.02026-07-2612071.0 KB

GET Custom Report

/reports/custom Permission level: 3

get/reports/custom

Query parameters

start_datestring date required

end_datestring date required

typestring required

enum[timesheets, confirmedtimesheets, shifts, confirmedshifts, openshifts]

fieldsstring required

The fields we want to have in the response. The list depends on the selected parameter type. For timesheets: 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'notes' For confirmedtimesheets: 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'rate', 'ratecard', 'special', 'overtime', 'cost', 'notes' For shifts: 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'title', 'notes' For confirmedshifts: 'employee', 'eid', 'user', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'title', 'notes' For openshifts: 'employees', 'slots', 'location', 'schedule_id', 'schedule_name', 'start_day', 'end_day', 'start_time', 'end_time', 'total_time', 'title', 'notes', 'published'

schedulestring

Array of Position (schedule) IDs (eg. 1639285,743314,743310) as comma-separated integer values

employeestring

Array of Employee IDs (eg. 1417022,4513152,2479828) as comma-separated integer values

locationinteger

skillstring

deduct_breaksinteger

Can be either 0 or 1

remote_siteinteger

optionsstring

Response

200

statusstring

tokenstring

Example response

{
  "status": "1",
  "data": [
    {
      "employee": "Alan"
    }
  ],
  "token": "xxxxxxx"
}