Read an absence
GEThttps://
Returns one absence.
Access
- Token scope
- api:
read: absences Without it:
403 insufficient-token-scope. - Permission
- absences::
manage Without it:
403 insufficient-permission. - Rate cost
- 1 unit, read bucket.
- Also
If-None-Matchanswers304when nothing changed. Never cached:private, no-store. Unknown query parameters are refused, never ignored.
Both are checked, scope first. A token never does more than its user. How access is checked
The summary and detail views are identical on this resource: every field is small enough for a list row. user and manager render as {"id": N} references; ?include=user,manager expands them, and that expansion additionally requires users::read and a token scope covering the users prefix. An absence whose employee has since been deleted keeps the reference form rather than expanding.
Path parameters
Query parameters
Unknown parameters are refused with 400, naming the parameter.
Request headers
A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.
Response 200
Returns a Absence in the detail view.
Headers
ETag- A strong validator of exactly this representation.
RateLimit- The IETF
httpapi-ratelimit-headersform of your remaining allowance on the tightest bucket this request touched. RateLimit-Policy- The ceiling and window of that bucket, as
<limit>;w=<seconds>. X-Request-Id- The server-generated ULID correlating this response with our logs.
Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning
The employee this absence is for. Writing it requires the absences::manage permission.
The employee the absence is for. Renders as an {"id": N} reference unless expanded, and stays a reference when the employee has since been deleted.
Manager who filed or approved the absence, or null when none was recorded. The foreign key nulls on delete, so removing the manager leaves the absence behind unattributed.
The manager who filed or approved the absence; absent when none was recorded.
When the absence ends, or null while it is still running. An ongoing absence reaches through now everywhere it is read (planning capacity and reporting both count it), and that reach is uncapped, so an absence nobody closed keeps consuming capacity. RFC 3339 UTC.
Errors
8 errors every operation can return: 304, 400, 401, 404, 406, 429, 500, 503
304 Not modified.
400 Bad request.
idempotency-key-requiredinvalid-cursorinvalid-query-parametermalformed-requestunsupported-parameter
401 Unauthenticated.
404 Not found.
406 Not acceptable.
429 Too many requests.
500 Server error.
503 Service unavailable.
This path allows GET, PATCH, DELETE. Anything else answers 405.
Something wrong or missing on this page? Tell us