Skip to main content
GET
List Workforce Absences
← Own Workforce API Return the absence and accident records of the header organization as a flat array.
This endpoint does not paginate and applies no row cap. Use List Workforce Absences Paginated unless you need the whole set at once, and narrow with created_at_from / created_at_to when you do.
These records are health data: sick-leave dates and hours, and the context of workplace accidents, each tied to an identifiable employee. That is special-category personal data under the GDPR. Do not log responses verbatim or cache them in shared stores, and restrict the API keys that can reach this endpoint.

One record, up to two events

A single record can describe an absence, an accident, or an accident that caused an absence. Which one it is shows in the fields, not in a discriminator: Read the accident_* fields only when accident_id is set, and the absenteeism_* fields only when absenteeism_id is set.
type is free text, captured as it was imported, and is not a controlled vocabulary. In practice organizations use their own labels in their own language, so the same concept appears under many spellings. Do not switch on it. For a reliable split, use accident_id / absenteeism_id as above, or the own_workforce_accidents and own_workforce_absenteeism datasets in Query datasets.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

array[string]
Filter by source upload file. The nil UUID 00000000-0000-0000-0000-000000000000 matches rows with no file.
datetime
Only rows created at or after this instant
datetime
Only rows created on or before this instant, inclusive
Free-text search, up to 255 characters

Response

A bare JSON array.
string
Record UUID
string
Employee the record belongs to
string
That employee’s identifier in your HR system
string
Free-text label as uploaded — see the note above
string | null
Set when the record includes a workplace accident
string | null
YYYY-MM-DD, when the accident happened
string | null
in_labore (at work) or in_itinere (commuting). This one is a closed set.
string | null
Set when the record includes an absence
string | null
First day of the absence
string | null
Last day. Null means the absence is open-ended.
number | null
Hours lost
string
User who created the record
string
ISO 8601 timestamp
string
ISO 8601 timestamp
string | null
Source upload file
string | null
Name of that file
string | null
Ingestion status: active once ingested, loading while its job runs, error if that job failed
string | null
Owning organization. Populated on group-view responses only.

Example

Successful Response

Common Errors

401 Unauthorized

Cause: the key is invalid, or it does not belong to the organization in x-organization-id — the two are looked up as a pair. A request carrying no credentials at all answers AUTH_REQUIRED instead.

403 Forbidden

Cause: the key’s owner is not an enabled member of the organization in x-organization-id.

List absences paginated

The same data, in pages

Absences of an employee

Narrowed to one person