v1/calendar/aggregations

get

https://shyftplan.com/api/v1/calendar/aggregations

Display aggregations of shifts and absences

Query Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

end_date

date

required

End date for aggregation

start_date

date

required

Start date for aggregation

locations_position_ids[]

array of int32s

Array of LocationsPosition ID

locations_position_ids[]

location_ids[]

array of int32s

Array of Location ID

location_ids[]

shift_rotation_group_ids[]

array of int32s

List of ShiftRotationGroup IDs

shift_rotation_group_ids[]

employment_ids[]

array of int32s

Array of Employment ID

employment_ids[]

shiftplan_ids[]

array of int32s

Array of Shiftplan ID

shiftplan_ids[]

Responses

200Successful response

403forbidden

404Company not found

422The request is invalid\nStart date and end date must be present\nStart date must be before end date\nDifference between start date and end date should be below 32 days