Skip to main content

getCompanyAvailability

GET 

/availability

Get the availability ("beschikbaarheid") of the Company related to your access token over one month, per date. This returns the same numbers as the Bedrijfsrooster databrowser availability report under "Capaciteit > Beschikbaarheid": per CompanyUser the total available hours per date, or per CompanyFunction the headcount of available CompanyUsers per date.

Beyond the report, each date is also broken down: for entity=companyUser the exact timespans that make up that date's total hours, and for entity=companyFunction the date split into concurrency segments — windows over which the number of simultaneously available CompanyUsers is constant.

Both breakdowns use full local date-times (YYYY-MM-DD HH:MM:SS) rather than times of day, because an availability window can run past midnight. Such a window is attributed in full to the date it STARTS on, so a consumer must not also count it under the following date.

The entity parameter is required and selects which of the two collections is returned. Requires the company:availability:read integration permission in addition to the OAuth ti_api_usr scope.

Request​

Responses​

Returns a CompanyUserAvailabilityCollection when entity=companyUser, or a CompanyFunctionAvailabilityCollection when entity=companyFunction.