GET Group Reports

Changed on

/group/reports Permission level: 3

get/groupaccounts/reports/

Request

  • Base URL
    https://www.humanity.com/api/v2
  • Auth
    API key in query parameter access_token

Query parameters

start_datestring date required
end_datestring date required
typestring required

enum[schedule_summary,shifts_confirmed, crib_sheet, shift_exchanges, shifts_summary, open_shifts, position_summary, daily_peak_hours, budget, confirmed_timesheets, all_timesheets, group_statistics, forecast]

schedulestring

Array of schedule ids (eg."234,563,770")

employeeinteger

employee id

accountinteger

Account id

locationinteger

location id

skillinteger
deduct_breaksinteger

Can be either 0 or 1 - if set to 1 it will deduct the breaks

remote_siteinteger
optionsinteger
group_resultsinteger

Can be 0 , 1 , 2 for grouping the results

Response

200

statusinteger
tokenstring
errorunknown

Example response

{
  "status": 1,
  "data": {
    "users": [
      {
        "id": "3475050",
        "name": "Alex Smith",
        "store": "303579",
        "eid": "123456",
        "group_id": "2",
        "location": "0"
      }
    ],
    "dates": [
      {
        "id": 3200,
        "formatted": "Feb 1, 2018"
      }
    ]
  },
  "token": "xxxxxxxx"
}

Changes