/api/v2/availabilities/daily_overview

get

https://shyftplan.com/api/v2/availabilities/daily_overview

Lists daily employee availability rows and aggregates by location/workplace.

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.

starts_at

string

required

First calendar day to include.

ends_at

string

required

Last calendar day to include.

selection_mode

string

enum

Defaults to explicit_availability

Whether to list only explicit availability time spans, or any time span without an explicit unavailability.

Allowed:

employment_ids[]

array of objects

List of employment IDs.

employment_ids[]

location_ids[]

array of objects

Filter for a list of location IDs.

location_ids[]

position_ids[]

array of objects

Filter for a list of position IDs.

position_ids[]

Responses

200Successfully listed

400Bad request

401Unauthorized

403Forbidden

404Not found

422Invalid request