List Jobs

Get a list of all Jobs available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit · integer · default: 100

The maximal number of entities returned, ordered by the last_updated field and external_id.

Required range: 1 <= x <= 200

Example:

50

offset · integer · default: 0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x >= 0

is_active · boolean · default: None

This parameter can be used to only include entities with the active attribute set to true or false. If the parameter is not set, all entities will be included.

Example:

true

job_family · string

This parameter can be used to only include Jobs in the specified job_family. If job_family="null", only Jobs without a Job Family are included. If the parameter is not set, all entities will be included.

Example:

"c3903505-eb84-42dc-a79f-5d8b1fe897b7"

low_data_availability · boolean

This parameter can be used to only include entities for which sufficient data is available (low_data_availability=false) or is not available (low_data_availability=true) for qualitative Skill inference. If the parameter is not set, all entities will be included.

Example:

true

include · enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Show child attributes

Example:

["custom_properties"]

Response

200

application/json

OK

count · integer · required

Total number of Job objects stored inside the system.

Required range: x >= 0

Example:

3

results · job_content · object[] · required

Subset of Jobs starting from offset up to offset + limit.

Show child attributes

Example:

[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-5fgqsef7b834c",
    "active": true,
    "job_name": "Front End Developer",
    "job_family_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "low_data_availability": false,
    "job_description": "The Front-End Developer is responsible for implementing visual elements that users interact with on the company's web applications."
  },
  {
    "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
    "active": true,
    "job_name": "Backend Developer",
    "job_family_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "low_data_availability": false,
    "job_description": "The Backend Developer is responsible for implementing the server-side logic of a web application."
  },
  {
    "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
    "active": true,
    "job_name": "Data Scientist",
    "job_family_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
    "low_data_availability": true,
    "job_description": "The Data Scientist is responsible for analyzing data and using it to make decisions."
  }
]