List Departments - Lucca API

Community

Status

Documentation

Files

Organization Structure API

Core HR API

Employees Directory
Guides

Cleemy Expenses API

Expense-temp-items
Expense-claims
Expense-claim-items
Exports

Cleemy Invoices API

Guides

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

GET

api

departments

curl --request GET \
  --url https://{host}/api/v3/departments \
  --header 'Authorization: <authorization>'

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

Headers

Authorization

string

required

API key. Value must be formatted like so: lucca application={api_key}.

Query Parameters

headId

integer

ID of the user who is head of the department.

parentId

integer

ID of the parent department.

paging

string

required

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

Example:

"100,0"

Response

200

application/json

data

object

data.items

object[]

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.

Was this page helpful?

The department resource

List Departements as a tree

curl --request GET \
  --url https://{host}/api/v3/departments \
  --header 'Authorization: <authorization>'

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