Retrieve a job-position

curl --request GET \
  --url https://{host}/lucca-api/job-positions/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{host}/lucca-api/job-positions/{id}"

headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Api-Version': '<api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://{host}/lucca-api/job-positions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/job-positions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/job-positions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/job-positions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "74",
  "type": "job-position",
  "url": "https://example.ilucca.net/lucca-api/job-positions/74",
  "remoteId": null,
  "employment": {
    "id": "28",
    "type": "employment",
    "url": "https://example.ilucca.net/lucca-api/employments/28"
  },
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/416"
  },
  "status": "active",
  "startsOn": "2024-01-01",
  "endsOn": null,
  "businessEstablishment": {
    "id": "5",
    "type": "business-establishment",
    "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
  },
  "jobTitle": "Developer",
  "jobQualification": {
    "id": "982",
    "type": "job-qualification",
    "url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
  },
  "manager": {
    "id": "541",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/541"
  },
  "occupationCategory": {
    "id": "12",
    "type": "occupation-category",
    "url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
  },
  "workingTimeArrangement": {
    "id": "23",
    "type": "working-time-arrangement",
    "url": "about:blank"
  },
  "department": {
    "id": "32",
    "type": "department",
    "url": "https://example.ilucca.net/lucca-api/departments/32"
  },
  "document": null,
  "notes": null,
  "t9n": {
    "jobTitle": {
      "fr-FR": "Développeur"
    }
  },
  "updatedAttributes": [
    "jobTitle",
    "jobQualification"
  ],
  "createdAt": "2024-04-15T23:12:54.0001Z",
  "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
  "links": {},
  "embedded": {
    "department": {
      "32": {
        "id": "32",
        "type": "department",
        "url": "https://example.ilucca.net/lucca-api/departments/32",
        "name": "Finances",
        "remoteId": "FIN",
        "isArchived": false,
        "parent": null,
        "level": 1,
        "manager": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "owningApplication": null,
        "links": {}
      }
    },
    "job-qualification": {
      "982": {
        "id": "982",
        "type": "job-qualification",
        "url": "https://example.ilucca.net/lucca-api/job-qualifications/982",
        "title": "Lead Developer",
        "profession": {
          "id": "89",
          "type": "profession",
          "url": "https://example.ilucca.net/lucca-api/professions/89"
        },
        "rank": 2,
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {}
      }
    },
    "employee": {
      "416": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416",
        "remoteId": "00002345",
        "portrait": {
          "id": "66512232",
          "type": "portrait",
          "url": "https://example.ilucca.net/lucca-api/portraits/66512232"
        },
        "givenName": "Edward",
        "familyName": "Atkinson",
        "employeeNumber": "E000124",
        "status": "active",
        "email": "eatkinson@acme.corp",
        "birthDay": {
          "day": 22,
          "month": 12
        },
        "phoneNumber": "+33145784512",
        "applicableEmployment": {
          "id": "154",
          "type": "employment",
          "url": "https://example.ilucca.net/lucca-api/employments/154"
        },
        "applicableJobPosition": {
          "id": "74",
          "type": "job-position",
          "url": "https://example.ilucca.net/lucca-api/job-positions/74"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "portrait": {
            "href": "https://example.ilucca.net/lucca-api/files/66512232?token=eyJhbGciOi"
          },
          "employments": {
            "href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
          },
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
          },
          "personalRecord": {
            "href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
          }
        }
      }
    },
    "employment": {
      "4561": {
        "id": "4561",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/4561",
        "remoteId": "EMPLOYMENT#4512-ac",
        "employee": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "legalEntity": {
          "id": "123",
          "type": "legal-entity",
          "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
        },
        "status": "active",
        "start": {
          "date": "2024-01-01"
        },
        "end": null,
        "document": {
          "id": "74411",
          "type": "file",
          "url": "https://example.ilucca.net/lucca-api/files/74411"
        },
        "template": {
          "id": "4",
          "type": "employment-template",
          "url": "https://example.ilucca.net/lucca-api/employment-templates/4"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
          },
          "probationaryPeriods": {
            "href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
          }
        }
      }
    }
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

GET

lucca-api

job-positions

{id}

Retrieve a job-position

curl --request GET \
  --url https://{host}/lucca-api/job-positions/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{host}/lucca-api/job-positions/{id}"

headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Api-Version': '<api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://{host}/lucca-api/job-positions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/job-positions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/job-positions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/job-positions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "74",
  "type": "job-position",
  "url": "https://example.ilucca.net/lucca-api/job-positions/74",
  "remoteId": null,
  "employment": {
    "id": "28",
    "type": "employment",
    "url": "https://example.ilucca.net/lucca-api/employments/28"
  },
  "employee": {
    "id": "416",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/416"
  },
  "status": "active",
  "startsOn": "2024-01-01",
  "endsOn": null,
  "businessEstablishment": {
    "id": "5",
    "type": "business-establishment",
    "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
  },
  "jobTitle": "Developer",
  "jobQualification": {
    "id": "982",
    "type": "job-qualification",
    "url": "https://example.ilucca.net/lucca-api/job-qualifications/982"
  },
  "manager": {
    "id": "541",
    "type": "employee",
    "url": "https://example.ilucca.net/lucca-api/employees/541"
  },
  "occupationCategory": {
    "id": "12",
    "type": "occupation-category",
    "url": "https://example.ilucca.net/lucca-api/occupation-categories/12"
  },
  "workingTimeArrangement": {
    "id": "23",
    "type": "working-time-arrangement",
    "url": "about:blank"
  },
  "department": {
    "id": "32",
    "type": "department",
    "url": "https://example.ilucca.net/lucca-api/departments/32"
  },
  "document": null,
  "notes": null,
  "t9n": {
    "jobTitle": {
      "fr-FR": "Développeur"
    }
  },
  "updatedAttributes": [
    "jobTitle",
    "jobQualification"
  ],
  "createdAt": "2024-04-15T23:12:54.0001Z",
  "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
  "links": {},
  "embedded": {
    "department": {
      "32": {
        "id": "32",
        "type": "department",
        "url": "https://example.ilucca.net/lucca-api/departments/32",
        "name": "Finances",
        "remoteId": "FIN",
        "isArchived": false,
        "parent": null,
        "level": 1,
        "manager": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "owningApplication": null,
        "links": {}
      }
    },
    "job-qualification": {
      "982": {
        "id": "982",
        "type": "job-qualification",
        "url": "https://example.ilucca.net/lucca-api/job-qualifications/982",
        "title": "Lead Developer",
        "profession": {
          "id": "89",
          "type": "profession",
          "url": "https://example.ilucca.net/lucca-api/professions/89"
        },
        "rank": 2,
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {}
      }
    },
    "employee": {
      "416": {
        "id": "416",
        "type": "employee",
        "url": "https://example.ilucca.net/lucca-api/employees/416",
        "remoteId": "00002345",
        "portrait": {
          "id": "66512232",
          "type": "portrait",
          "url": "https://example.ilucca.net/lucca-api/portraits/66512232"
        },
        "givenName": "Edward",
        "familyName": "Atkinson",
        "employeeNumber": "E000124",
        "status": "active",
        "email": "eatkinson@acme.corp",
        "birthDay": {
          "day": 22,
          "month": 12
        },
        "phoneNumber": "+33145784512",
        "applicableEmployment": {
          "id": "154",
          "type": "employment",
          "url": "https://example.ilucca.net/lucca-api/employments/154"
        },
        "applicableJobPosition": {
          "id": "74",
          "type": "job-position",
          "url": "https://example.ilucca.net/lucca-api/job-positions/74"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "portrait": {
            "href": "https://example.ilucca.net/lucca-api/files/66512232?token=eyJhbGciOi"
          },
          "employments": {
            "href": "https://example.ilucca.net/lucca-api/employments?employee.id=416"
          },
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.employee.id=416"
          },
          "personalRecord": {
            "href": "https://example.ilucca.net/lucca-api/employee-personal-records?employee.id=416"
          }
        }
      }
    },
    "employment": {
      "4561": {
        "id": "4561",
        "type": "employment",
        "url": "https://example.ilucca.net/lucca-api/employments/4561",
        "remoteId": "EMPLOYMENT#4512-ac",
        "employee": {
          "id": "416",
          "type": "employee",
          "url": "https://example.ilucca.net/lucca-api/employees/416"
        },
        "legalEntity": {
          "id": "123",
          "type": "legal-entity",
          "url": "https://example.ilucca.net/lucca-api/legal-entities/123"
        },
        "status": "active",
        "start": {
          "date": "2024-01-01"
        },
        "end": null,
        "document": {
          "id": "74411",
          "type": "file",
          "url": "https://example.ilucca.net/lucca-api/files/74411"
        },
        "template": {
          "id": "4",
          "type": "employment-template",
          "url": "https://example.ilucca.net/lucca-api/employment-templates/4"
        },
        "createdAt": "2024-04-15T23:12:54.0001Z",
        "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
        "links": {
          "jobPositions": {
            "href": "https://example.ilucca.net/lucca-api/job-positions?employment.id=4561"
          },
          "probationaryPeriods": {
            "href": "https://example.ilucca.net/lucca-api/probationary-periods?employment.id=4561"
          }
        }
      }
    }
  }
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

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

string

required

Identifier of the job-position to retrieve.

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.

Response

A job-position resource.

string

Minimum string length: 1

type

string

Allowed value: "job-position"

url

string<uri>

remoteId

null | string

Resource identifier in a third-party system. No unicity constraint: two job-positions may have the same value.

Required string length: 1 - 1024

employment

employment-reference · object

Reference to an employment resource.

Show child attributes

employee

employee-reference · object

Read-only. Reference to the employment's employee.

Show child attributes

status

enum<string>

Read-only. The employee status is calculated from the employee's employments.

active: employee has an employment as of today.
upcoming: employee currently has no employment but will have one in the future.
deactivated: employee used to have an employment but no longer does.

Available options:

active,

upcoming,

deactivated

Example:

"active"

startsOn

string<date>

Effective date of this job-position for this employee.

Cannot be outside the range of the employment.

This should be considered "applicable" based on the related employment business-establishment timezone.

Pattern: ^\d{4}-\d{2}-\d{2}$

endsOn

null | string<date>

Read-only. End date (included) of this job-position effectiveness.

Is calculated from the startsOn property of the closest next job-position, or the endsOn date of the parent employment.

This should be considered "applicable" based on the related employment business-establishment timezone.

Must be greater or equal than StartsOn date.

Pattern: ^\d{4}-\d{2}-\d{2}$

businessEstablishment

business-establishment-reference · object

Reference to a business-establishment resource.

Show child attributes

jobTitle

null | string

Short description of the job occupied by this employee.

Required string length: 1 - 1024

jobQualification

job-qualification-reference · object | null

Reference to a job-qualification resource.

Show child attributes

manager

employee-reference · object | null

Reference to another employee, who is considered to be this employee's manager.

Show child attributes

occupationCategory

occupation-category-reference · object | null

Reference to an occupation-category resource.

Show child attributes

workingTimeArrangement

working-time-arrangement-reference · object | null

Reference to a working-time-arrangement resource.

Show child attributes

department

department-reference · object

Reference to a department resource.

Show child attributes

document

file-reference · object | null

Reference to a file resource.

Show child attributes

notes

null | string

Optional notes about this job-position change.

Maximum string length: 500

t9n

object

Show child attributes

updatedAttributes

enum<string>[]

List of attributes that changed compared with this employee previous job-position, even if said job-position was on another employment and/or not immediately sequential.

List of attributes that can change for a job-position.

Available options:

remoteId,

jobTitle,

jobQualification,

occupationCategory,

workingTimeArrangement,

department

createdAt

string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

lastUpdatedAt

string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

links

object

Show child attributes

embedded

object | null

Embeds the representation of resources related to the job-position(s).

Only returned if requested by the API client: ?include=embedded.

Show child attributes

Overview

Files

Organization

Employee Records

Time Management

Events & Webhooks

Retrieve a job-position

Authorizations

Headers

Path Parameters

Query Parameters

Response