Departments
List Departments
Documentation
Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
- Employees Directory
- Guides
Cleemy Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
Timmi Absences API
- Leaves
- Leave-requests
- Sick-leaves
- Imports
- Guides
Timmi Office API
- User-locations
- Work-locations
Timmi Project API
- Clients
- Projects
- Project services
- Organizations
- Financials
Timmi Settings API
- UserDates
- Workcycle-exceptions
- Working-time-arrangement
Timmi Timesheet API
- Time-entries
- Timesheets
- Reports
- Guides
Pagga Mealvouchers API
- Statutory
- Computation
Pagga Remuneration API
- Fixed-natures
- Fixed-items
- Variable-natures
- Variable-items
Poplee Training API
- Training-demands
- Realized-trainings
Departments
List Departments
List all Departments satisfying query filters.
GET
/
api
/
v3
/
departments
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/departments{
"data": {
"items": [
{
"id": 2,
"name": "Administration",
"code": "Administration",
"hierarchy": "/1.0/",
"parentId": "/",
"position": 10000000000000000000,
"sortOrder": 1,
"level": 1,
"isActive": true,
"headID": null,
"head": null,
"users": [
{
"id": 11,
"name": "Daniel Hernandez",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/11"
},
{
"id": 36,
"name": "henri paul",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/36"
}
],
"currentUsers": [
{
"id": 11,
"name": "Daniel Hernandez",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/11"
},
{
"id": 36,
"name": "henri paul",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/36"
}
],
"url": "https://sandbox.ilucca-demo.net/api/v3/departments/2"
}
]
}
}Query Parameters
{offset},{limit}. Defaults to 0,1000.
Example:
"100,0"
Response
200
application/json
OK
Departments, to which users must be attached, are used by the different Lucca solutions for different purposes:
- Define access scopes: for example to restrict the visibility of absences in the Timmi Absences schedule.
- Filtering data in a report: our different reports generally allow to filter data according to the legal entity, the SSC, but also the department of the user.
- Build the organization chart in Poplee Core HR. The departments are represented as a hierarchical tree with a parent/child relationship.
NB: You can have up to 9 levels of departments, and up to 99 departments under a single parent department. However, limiting the number of levels to 7 is recommended.
Maximum length:
255Maximum length:
255Position of the departement in the hierarchical tree
Position of the parent department in the hierarchical tree
Department's general position in the hierarchy
Required range:
10000000000000000000 <= x <= 100000000000000000000level of the Department. Deduce from Position.
Order of the current Department among the children of the Parent Department
Required range:
x >= 1ID of the User who is the head of the department
Number of active users in the department
Required range:
x >= 0Was this page helpful?
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/departments{
"data": {
"items": [
{
"id": 2,
"name": "Administration",
"code": "Administration",
"hierarchy": "/1.0/",
"parentId": "/",
"position": 10000000000000000000,
"sortOrder": 1,
"level": 1,
"isActive": true,
"headID": null,
"head": null,
"users": [
{
"id": 11,
"name": "Daniel Hernandez",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/11"
},
{
"id": 36,
"name": "henri paul",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/36"
}
],
"currentUsers": [
{
"id": 11,
"name": "Daniel Hernandez",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/11"
},
{
"id": 36,
"name": "henri paul",
"url": "https://sandbox.ilucca-demo.net/api/v3/users/36"
}
],
"url": "https://sandbox.ilucca-demo.net/api/v3/departments/2"
}
]
}
}