Skip to main content
Get Vacancy
curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/vacancies/{external_id} \
  --header 'Authorization: Bearer <token>'
{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "job_title": "Software engineer",
  "job_description": "We are looking for a software engineer with great communication Skills in Ghent. Experience in front-end development, git, agile working is a plus.",
  "active": true,
  "languages": [
    {
      "language": "nl",
      "level": 3
    }
  ],
  "company": "b3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "location": {
    "lat": 51.0216707,
    "lng": 3.6887328
  },
  "last_updated": "2021-01-21T17:32:28Z",
  "custom_properties": [
    {
      "property_name": "creation_date",
      "property_value": "2020-03-07"
    },
    {
      "property_name": "language",
      "property_value": "de"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
external_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Query Parameters

​
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.

Example:
["custom_properties"]

Response

OK

Default structure for Vacancy data. Default structure for updating Vacancy data.

​
last_updated
string<date-time>
required

Timestamp of the last update to this entity.

Example:

"2021-01-21T17:32:28Z"

​
external_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

​
job_title
string
required

Title of the Vacancy.

Required string length: 1 - 255
Example:

"Software engineer"

​
job_description
string
required

Textual description of the Vacancy (job posting).

Minimum length: 1
Example:

"We are looking for a software engineer with great communication Skills in Ghent. Experience in front-end development, git, agile working is a plus."

​
location
object

A geographic location, expressed in latitude and longitude. This can represent a home address, an office location... Each entity is limited to having a single location. To get the latitude and longitude for a given address, you can use the Google Maps Geocoding API or a predefined lookup table (for example by zip code). If location is present in matching or filters, it will act as an override for geo-distance calculations.

​
languages
object[] | null

Required languages associated with this Vacancy. List of ISO 639-1 language codes, combined with the proficiency level. The proficiency levels go from 1 (elementary proficiency) to 5 (native proficiency). If the level is omitted, the default proficiency level of 2 is used. List of ISO 639-1 codes for languages required by the Vacancy, combined with the proficiency level. The proficiency levels go from 1 (elementary proficiency) to 5 (native proficiency). If the level is omitted, the default proficiency level of 2 is used.

​
custom_properties
object[]

A list of properties for a given entity. Property values are either strings or numbers.

Example:
[
  {
    "property_name": "creation_date",
    "property_value": "2020-03-07"
  },
  {
    "property_name": "language",
    "property_value": "de"
  }
]
​
active
boolean | null
default:true

The Vacancy will not be used in matching if active is false. This is useful when a Vacancy is being phased out.

Example:

true

​
company
string<uuid> | null

external_id from the External Company the Vacancy is linked to.

Minimum length: 1
Example:

"b3903505-eb84-42dc-a79f-5e7b1fe897b7"

⌘I