v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Departments

List Departments (v3)

List all Departments satisfying query filters.

get/api/v3/departments

Query parameters

headIdinteger

ID of the user who is head of the department.

parentIdinteger

ID of the parent department.

pagingstring required
Example:2000,500

{offset},{limit}. Defaults to 0,1000.

Response

OK

Example response

{
  "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"
      }
    ]
  }
}