GET
/
lucca-api
/
job-positions
curl --request GET \
  --url https://{host}/lucca-api/job-positions \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "type": "job-positions",
  "url": "https://example.ilucca.net/lucca-api/job-positions?limit=10",
  "totalCount": 872,
  "items": [
    {
      "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"
      },
      "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,
      "changedAttributes": [
        "jobTitle",
        "jobDescription",
        "jobQualification"
      ],
      "createdAt": "2024-04-15T23:12:54.0001Z",
      "lastUpdatedAt": "2024-04-15T23:12:54.0001Z",
      "links": null
    }
  ],
  "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"
        },
        "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": {
          "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"
        },
        "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"
          },
          "trialPeriods": {
            "href": "https://example.ilucca.net/lucca-api/trial-periods?employment.id=4561"
          }
        }
      }
    }
  },
  "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
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.

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
id
string[]

Filter out job-positions on their IDs. Comma-separated list of strings.

Maximum length: 100
Examples:
["345", "985"]
remoteId
string[]

Filter out job-positions on their remoteId. Comma-separated list of strings.

Maximum length: 100
Examples:
["JOB000423"]
employment.id
string[]

Filter out job-positions on their employment IDs. Comma-separated list of strings.

Maximum length: 100
Examples:
["90", "74"]
businessEstablishment.id
string[]

Filter out job-positions on their business-establishment IDs. Comma-separated list of strings.

Maximum length: 100
Examples:
["1", "3"]
startsOn
string

Filter out job-positions on their startsOn date (strict equality).

startsOn.between
string

Filter out job-positions on their startsOn date (range). ISO 8601 formatted date-range string.

Examples:

"2024-01-01--2024-12-31"

"..--2024-12-31"

"2024-01-01--.."

endsOn

Filter out job-positions on their endsOn date (strict equality).

endsOn.between
string

Filter out job-positions on their endsOn date (range). ISO 8601 formatted date-range string.

Examples:

"2024-01-01--2024-12-31"

"..--2024-12-31"

"2024-01-01--.."

jobQualification.id
string[]

Filter out job-positions on their job-qualification IDs. Comma-separated list of strings.

Maximum length: 100
Examples:
["45", "56"]
occupationCategory.id
string[]

Filter out job-positions on their occupation-category IDs. Comma-separated list of strings.

Maximum length: 100
Examples:
["17", "18"]
manager.id
string[]

Filter out job-positions on their manager IDs. Comma-separated list of strings.

Maximum length: 100
Examples:
["123", "456"]
department.id
string[]

Filter out job-positions on their department IDs. Comma-separated list of strings.

Maximum length: 100
Examples:
["43"]
changedAttributes
enum<string>[]

Only return job-positions that changed one of the given attributes.

Maximum length: 100
Examples:
["jobTitle"]
sort
enum<string>[]

Order results by instruction. Read more about sorting. Default: id.

Maximum length: 100
Examples:
["id"]

Response

200
application/json

OK

A collection of job-position resources. Links on a collection. Embedded resources on a job-position(s) response. A collection of job-position objects.