Skip to main content
GET
/
lucca-api
/
occupation-categories
List occupation-categories
curl --request GET \
  --url https://{host}/lucca-api/occupation-categories \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "occupation-categories",
  "url": "https://example.ilucca.net/lucca-api/occupation-categories?limit=25",
  "totalCount": 29,
  "items": [
    {
      "id": "45",
      "type": "occupation-category",
      "url": "https://example.ilucca.net/lucca-api/occupation-categories/45",
      "title": "Executive",
      "businessEstablishments": [
        {
          "id": "5",
          "type": "business-establishment",
          "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
        }
      ],
      "t9n": {
        "title": {
          "fr-FR": "Cadre"
        }
      },
      "links": {}
    }
  ],
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/occupation-categories?page=!43df&limit=25"
    }
  },
  "embedded": {}
}
Scopes: 
    • occupation-categories.readonly
    • occupation-categories.readwrite
Business-establishments: Any in occupation-category related business-establishments.
About authentication

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:
TitleConst
2024-11-01
Examples:

"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.

Examples:

"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.

Examples:

"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.

​
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.

Maximum length: 100
Example:
["1", "3"]
​
search
string

Filter occupation-categories by their title. The search is case insensitive and looks for partial matches.

Minimum length: 1
​
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

OK

A collection of occupation-category resources. Embedded resources on a occupation-category(ies) response. Links on a collection.

​
type
string
required
Allowed value: "occupation-categories"
​
url
string<uri>
required
​
items
occupation-category · object[]
required
Maximum length: 100
​
embedded
object | null
​
totalCount
integer | null

Total number of ocupation-category resources across all pages that satisfy query parameters.

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

Links to related resources