Skip to main content
GET
/
lucca-api
/
professions
/
{id}
Retrieve a profession
curl --request GET \
  --url https://{host}/lucca-api/professions/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "id": "89",
  "type": "profession",
  "url": "https://example.ilucca.net/lucca-api/professions/89",
  "title": "Developer",
  "isArchived": false,
  "t9n": {
    "title": {
      "fr-FR": "Développeur"
    }
  },
  "links": {},
  "embedded": {}
}
Scopes: 
    • job-qualifications.readonly
    • job-qualifications.readwrite
Business-establishments: Any.
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:
2024-11-01
Allowed value: "2024-11-01"
Maximum string length: 10
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.

Path Parameters

​
id
string
required

Identifier of the profession to retrieve.

Minimum string length: 1

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

Response

OK

A profession resource.

​
title
string
required

Must be unique. Leading and trailing spaces are automatically removed.

Required string length: 1 - 255
​
id
string
Minimum string length: 1
​
type
string
Allowed value: "profession"
​
url
string<uri>
​
isArchived
boolean

Once archived, a profession can no longer be referenced by new job-qualifications.

​
t9n
object
​
links
object
​
embedded
object