curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/vacancies \
  --header 'Authorization: Bearer <token>'
{
  "count": 3,
  "results": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "job_title": "Staffing coordinator",
      "job_description": "We are looking for a competent Staffing coordinator to undertake a variety of tasks such as recruitment, orientation and placement of Employees. You will also be the one to ensure that the Company complies with all relevant laws regarding employment.",
      "location": {
        "lat": 51.0216707,
        "lng": 2.6887328
      },
      "company": "8cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "active": true,
      "last_updated": "2021-01-21T17:32:28Z"
    },
    {
      "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
      "job_title": "HR assistant",
      "job_description": "We are looking for an HR Assistant to undertake a variety of HR administrative duties.",
      "location": {
        "lat": 50.0216707,
        "lng": 3.6887328
      },
      "company": "9abdbdbe-5f44-4423-8157-520f8a2f429a",
      "active": true,
      "last_updated": "2021-01-22T15:02:00Z"
    },
    {
      "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
      "job_title": "HR analyst",
      "job_description": "We are looking for an HR Analyst to gather and process qualitative and quantitative data around jobs, compensation and employment trends.",
      "location": {
        "lat": 51.0516707,
        "lng": 4.6887328
      },
      "company": "9hbdbdbe-5f44-4423-8157-520f8a2f429a",
      "active": true,
      "last_updated": "2021-01-21T17:46:29Z"
    }
  ]
}

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

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

Available options:
custom_properties
Example:
["custom_properties"]

Response

200
application/json
OK
​
count
integer
required

Total number of Vacancy objects stored inside the system.

Required range: x >= 0
Example:

3

​
results
object[]
required

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

Default structure for Vacancy data.

Example:
[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "job_title": "Staffing coordinator",
    "job_description": "We are looking for a competent Staffing coordinator to undertake a variety of tasks such as recruitment, orientation and placement of Employees. You will also be the one to ensure that the Company complies with all relevant laws regarding employment.",
    "location": { "lat": 51.0216707, "lng": 2.6887328 },
    "company": "8cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "active": true,
    "last_updated": "2021-01-21T17:32:28Z"
  },
  {
    "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
    "job_title": "HR assistant",
    "job_description": "We are looking for an HR Assistant to undertake a variety of HR administrative duties.",
    "location": { "lat": 50.0216707, "lng": 3.6887328 },
    "company": "9abdbdbe-5f44-4423-8157-520f8a2f429a",
    "active": true,
    "last_updated": "2021-01-22T15:02:00Z"
  },
  {
    "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
    "job_title": "HR analyst",
    "job_description": "We are looking for an HR Analyst to gather and process qualitative and quantitative data around jobs, compensation and employment trends.",
    "location": { "lat": 51.0516707, "lng": 4.6887328 },
    "company": "9hbdbdbe-5f44-4423-8157-520f8a2f429a",
    "active": true,
    "last_updated": "2021-01-21T17:46:29Z"
  }
]

Was this page helpful?

OverviewCreate Vacancy