GET
/
lucca-api
/
professions
curl --request GET \
  --url https://{host}/lucca-api/professions \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "professions",
  "url": "https://example.ilucca.net/lucca-api/professions?limit=10",
  "totalCount": 23,
  "items": [
    {
      "id": "89",
      "type": "profession",
      "url": "https://example.ilucca.net/lucca-api/professions/89",
      "title": "Developer",
      "isArchived": true,
      "t9n": {
        "title": {
          "fr": "Développeur"
        }
      },
      "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
​
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
​
isArchived
boolean

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

Response

200
application/json
OK

A collection of profession resources.

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

A profession represent a type of job practiced in the company. Examples may be:

  • Software engineering ;
  • Consulting ;
  • HR operations ;
  • Finances ;
  • Sales ;
  • etc...
​
totalCount
integer | null

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