Reads all Incidences
Changed onReads all Incidences
Request
- Base URLhttps://api.factorialhr.com
- URLhttps://api.factorialhr.com/api/2026-10-01/resources/bookkeepers_management/incidences
- Auth
- OAuth 2Authorization code: https://id.factorialhr.com/oauth/authorizeToken URL: https://id.factorialhr.com/api/oauth/token scopes: employee_updates
- or API key in header x-api-key
Query parameters
A list of incidence identifiers.
[ "1", "2", "3" ]
A list of legal entities identifiers.
[ "1", "2", "3" ]
A list of statuses.
[ "in-preparation", "to-do", "doing", "done", "discarded" ]
Get the incidence (aka employee update) that start safter this date (included).
Get the incidence (aka employee update) that ends before this date (included).
A list of types. It can be any of the following address, bank, cost_center, contract, gender, health_insurance, hiring, id, irpf, legal_entity, manual_incidence, name, nationality, parental, permits_and_certificates, phone_number, sick, tax_id, taxes_and_deductions, termination, work_activity, workplace
[ "hiring", "workplace" ]
Field to sort by. It can be any of the following employee_first_name, employee_last_name, type, legal_entity_name, effective_date, status, created_at.
Sort direction. It can be 'asc' or 'desc'.
Filter the result by the name of the employee.
A list of employee identifiers.
[ "1", "2", "3" ]
Boolean that filters incidences that does or does not contains messages.
Filter by message sender.
A list of custom leave names.
[ "Medical Leave", "Paternity Leave" ]
Response
OK
Example response
{
"data": [
{
"id": "1",
"employee_id": "1",
"legal_entity_id": "1",
"name": "hiring",
"target_id": "1",
"target_type": "Timeoff::Leave",
"starts_on": "2020-01-01",
"ends_on": "2020-01-01",
"read_at": "2020-01-01",
"company_id": "1",
"message_from": "admin",
"has_message": true,
"is_reopened": true
}
]
}Changes
- info
endpoint added
- info