GET
/
lucca-api
/
occupation-categories
curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/occupation-categories \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "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
​
businessEstablishments.id
string[]

Only return occupation-categories belonging to at least one of the given business-establishment IDs.

Note: occupation-categories with a null relationship with business-establishments must be considered belonging to ALL of them. As a result, you may retrieve such occupation-categories when filtering them out on their business-establishment IDs.

Example:
["1", "3"]
​
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 occupation-category resources.

​
type
string
required
Allowed value: "occupation-categories"
​
url
string
required
​
items
object[]
required

The occupation-category resource represents a categorization of employees belonging to a set of business-establishments.

These categories can be used as a way of distinguishing employees in reports, or may be used to specify reserved business rules (e.g. in the leaves management system).

In France, can be used to represent the "Profession et Catégories Professionnelles" (P.C.S.).

​
totalCount
integer | null

Total number of ocupation-category 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?