GET
/
lucca-api
/
departments
curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/departments \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "departments",
  "url": "https://example.ilucca.net/lucca-api/departments?page=54sd5df24d5&limit=10",
  "totalCount": 11,
  "items": [
    {
      "id": "32",
      "type": "department",
      "url": "https://example.ilucca.net/lucca-api/departments/32",
      "name": "Finances",
      "description": null,
      "remoteId": "FIN",
      "isArchived": false,
      "parent": null,
      "level": 1,
      "sortOrder": 2,
      "manager": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416"
      },
      "links": {}
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Authorizations

​
Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

​
Api-Version
enum<string>
required

Set the API version.

Available options:
2024-11-01
Example:

"2024-11-01"

​
If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

​
If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

​
Accept-Encoding
string

List of compression algorithms you support.

Query Parameters

​
include
enum<string>[]

Include metadata:

  • embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
  • links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
  • totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Available options:
embedded,
links,
totalCount
​
isArchived
boolean

When omitted: return both archived and non-archived resources. When true: only return archived resources. When false: only return non-archived resources.

​
page
string

Cursor of the page to retrieve. Read more about pagination.

​
limit
integer
default:25

Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.

Required range: 0 <= x <= 100

Response

200
application/json
OK

A collection of department resources.

​
type
string
required
Allowed value: "departments"
​
url
string
required
​
items
object[]
required

A department represents a subdivision of the employee workforce, most often erected around the type of activity they do.

Departments are a tree-like structure, as any department may be child to another.

Note: contrary to most resources, departments are not attached to business-establishments. This means:

  • business-establishments listed in access rights management do not affect departments.
  • employees may work in different business-establishments (or even legal-entities) and yet still belong to the same department.
​
totalCount
integer | null

Total number of department resources across all pages that satisfy query parameters.

Required range: x >= 0
​
embedded
null
​
links
object | null

Links to related resources

Was this page helpful?