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
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 504
Returns a CompanyUserAvailabilityCollection when entity=companyUser, or a CompanyFunctionAvailabilityCollection when entity=companyFunction.
Invalid request data.
Access token missing, invalid or expired.
Response Headers
Points to protected-resource metadata when authentication is missing.
Bearer resource_metadata="https://api.bedrijfsrooster.nl/.well-known/oauth-protected-resource"The access token lacks the required scope, or the authorized user or integration does not have permission to access this company or resource.
Either the requested route does not exist, or (for these proxied routes) the legacy PHP backend reported the requested resource as not found.
Request rate limit exceeded. See the X-RateLimit-* and Retry-After response headers for details.
Response Headers
Maximum number of requests allowed per window (default 25).
Number of requests remaining in the current window.
Milliseconds until the current window resets.
Seconds to wait before retrying.
An unhandled error occurred. Internal error detail is never echoed on 5xx responses — this generic message is always used instead.
The upstream service did not respond before the request deadline.