curl --request GET \
--url https://{host}/api/v3/departments \
--header 'Authorization: <authorization>'{
"data": {
"items": [
{
"name": "<string>",
"code": "<string>",
"id": 123,
"hierarchy": "<string>",
"parentId": "<string>",
"isActive": true,
"position": 55000000000000000000,
"level": 123,
"sortOrder": 2,
"headID": 123,
"head": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"users": [
{
"id": 123,
"name": "<string>",
"url": "<string>"
}
],
"currentUsers": [
{
"id": 123,
"name": "<string>",
"url": "<string>"
}
],
"currentUsersCount": 1
}
]
}
}List all Departments satisfying query filters.
curl --request GET \
--url https://{host}/api/v3/departments \
--header 'Authorization: <authorization>'{
"data": {
"items": [
{
"name": "<string>",
"code": "<string>",
"id": 123,
"hierarchy": "<string>",
"parentId": "<string>",
"isActive": true,
"position": 55000000000000000000,
"level": 123,
"sortOrder": 2,
"headID": 123,
"head": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"users": [
{
"id": 123,
"name": "<string>",
"url": "<string>"
}
],
"currentUsers": [
{
"id": 123,
"name": "<string>",
"url": "<string>"
}
],
"currentUsersCount": 1
}
]
}
}API key. Value must be formatted like so: lucca application={api_key}.
ID of the user who is head of the department.
ID of the parent department.
{offset},{limit}. Defaults to 0,1000.
"100,0"
OK
Show child attributes
Show child attributes
255255Position of the departement in the hierarchical tree
Position of the parent department in the hierarchical tree
Department's general position in the hierarchy
10000000000000000000 <= x <= 100000000000000000000level of the Department. Deduce from Position.
Order of the current Department among the children of the Parent Department
x >= 1ID of the User who is the head of the department
Number of active users in the department
x >= 0Was this page helpful?