Retrieve an absence policy
Retrieve a single absence policy by its id (UUID v7), including the UUIDs of its associated absence types and the count of assigned employees. A policy belonging to another company returns 404 absence_policy_not_found (anti-enumeration).
Request
- Base URL: https://api.factuarea.com/v1
- URL: https://api.factuarea.com/v1/companies/{company}/absence-policies/{absence_policy}
- Auth: one of:
- HTTP bearer
- API key in header X-API-Key
Path parameters
Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).
Public identifier (UUID v7) of the absence policy.
Headers
Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.
Response
Example response
{
"data": {
"id": "01933a31-d176-7082-8e9f-6f7a8b9c0d01",
"object": "absence_policy",
"name": "Vacaciones estándar",
"allowance_type": "limited",
"allowance_days": 23,
"accrual_method": "annual",
"absence_type_ids": [
"01933a30-c065-7f71-9d8e-5e6f7a8b9c01"
],
"assigned_employee_count": 12,
"status": "active",
"carryover": {
"type": "capped",
"max_days": 5,
"expiry_month": 3,
"expiry_day": 31
},
"created_at": "2024-09-01T10:00:00Z",
"updated_at": "2024-09-01T10:00:00Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.