List File Categories
GET /services/api/v1/employee_file_categories
Returns a list of employee file categories.
Response
Results list.
- Example
- Schema
{
"entries": [
{
"id": "A96ey16n",
"type_of": "signatures",
"name_de": "Signierte Dokumente",
"name_it": "Documenti firmati",
"name_en": "Signed documents",
"ancestor_id": null,
"depth": 0,
"subtree_ids": ["A96ey16n"],
"ancestor_ids": []
},
{
"id": "Lez8GJ6g",
"type_of": "application",
"name_de": "Bewerbungsunterlagen",
"name_it": "Documenti della candidatura",
"name_en": "Application documents"
"ancestor_id": null,
"depth": 0,
"subtree_ids": ["Lez8GJ6g"],
"ancestor_ids": []
},
{
"id": "Bj893Hm",
"type_of": "custom",
"name_de": "Sonstige Unterlagen",
"name_it": "Altri documenti",
"name_en": "Other documents",
"ancestor_id": null,
"depth": 0,
"subtree_ids": ["Bj893Hm"],
"ancestor_ids": []
}
],
"current_page": 1,
"per_page": 30,
"total_entries": 3
}
Attribute | Type | Description |
---|---|---|
id | string | Employee file category id. |
type_of | string | Type of the employee file category. Possible values: ["custom", "application", "hiring", "person", "tax", "social", "salary", "retirement", "certificates", "trainings", "signatures", "horeca_hero", "d3"] . |
name_{locale} | string | Employee file category name in all locales of the business. |
ancestor_id | string | Employee file category tree ancestor |
depth | int | Depth of the employee file category in the tree structure. |
subtree_ids | string[] | All children categories of the employee file category. |
ancestor_ids | string | Employee file category ancestors |