v1/availability_aggregations

get

https://shyftplan.com/api/v1/availability_aggregations

Gets all availabilities aggregated

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.

employment_ids[]

array of int32s

Array of Employment ID

employment_ids[]

ends_at

date-time

required

End of time frame in ISO 8601 format with time and UTC offset (time is nullified)

location_ids[]

array of int32s

Array of Location ID

location_ids[]

order_key

string

enum

Defaults to employee_last_name

Sort keys

Allowed:

order_dir

string

enum

Defaults to desc

Sort direction

Allowed:

page

int32

≥ 1

Defaults to 1

Number of the page of responses to retrieve. First page: 1.

per_page

int32

1 to 1000

Defaults to 500

Number of responses on each page.

position_ids[]

array of int32s

Array of Position ID

position_ids[]

starts_at

date-time

required

Start of time frame in ISO 8601 format with time and UTC offset (time is nullified)

Responses

200Aggregations for availabilities listed successfully.

403Forbidden.

404Couldn't find company.

422The request is invalid.Start date should be earlier than end date.Current company cannot be blank.