getCompanyReport
GET/reports
Get one finished report of the Company related to your access token, by its reportId. A report is a computed Bedrijfsrooster rapportage (for example companyReliefHours, the year balance of relief hours) that the app generated earlier; this returns its stored result exactly as the app receives it, under Data. The shape of Data depends on the report's typeConstant.
A report that is not finished yet is an error, not a partial result: HTTP 409 with the progress inside the message as percentage_complete [<n>] (integer 0-100), so poll again later. A report that belongs to another company answers 403; an unknown or deleted reportId answers 404. Requires the company:reports:read integration permission in addition to the OAuth ti_api_usr scope.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 429
- 500
- 504
The finished report with its decoded result under Data.
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.
No report with this reportId exists, or it was deleted.
The report exists and is yours but is not finished yet. The message ends with percentage_complete [<n>]; poll again later.
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.