Interface (API) for query of job offers

The published job ads of onboard can be queried via a JSON interface.

API Endpoints

The endpoint can be reached via the following URL:

https://<company>.onboard.org/exports/v2/jobs.json

Additionally there are individual endpoints per language. The language can be specified in ISO 639-1 format (e.g. “de”, “it”, or “en”). The endpoint is accessible via the following URLs:

https://<company>.onboard.org/<language>/exports/v2/jobs.json

https://<company>.onboard.org/de/exports/v2/jobs.json
https://<company>.onboard.org/it/exports/v2/jobs.json
https://<company>.onboard.org/en/exports/v2/jobs.json
...

It is also possible to query single job openings:

https://<company>.onboard.org/exports/v2/jobs/<job-id>.json

Parameters

• campaign: Campaign through which the job offers are to be filtered
• publication_channel: Channel through which the job offers are to be filtered
• show_on_career_site: Show only job offers that are displayed on the website. Allowed values are true or false.
• location_id: Displays only job ads from this location
• location_ids[]: Displays only job ads from this locations
• department_id: Displays only job ads from this department
• department_ids[]: Displays only job ads from this departments
• subtree_department_id: Displays only job ads from this department and its sub-departments

Example:

https://<company>.onboard.org/de/exports/v2/jobs.json?publication_channel=292hAjyX&show_on_career_site=true

The exact API endpoint with tracking parameters is available from our support team upon request.

Content

Certain fields are translatable (e.g. “title”). If no language is specified in the URL, all possible translations are returned (e.g. “title_de”, “title_en”). If a language is specified, only the selected language is returned.

The interface contains all the required information about the job advertisement:

• id: unique ID
• languages: languages in which the job ad was published
• published_at: publishing date
• url: link to job offer
• form_url: Link directly to application form
• image_url: background image of job offer
• title: titel
• description: description (could contain HTML-code)
• business: information about the business
• locations: location(s). For details see here.
• departments: department(s). For details see here.
• types: type of employment; possible options:
  full_time: full time
  part_time: part time
  remote: remote (home office) possible
  internship: internship
  apprenticeship: apprenticeship
  unlimited: unlimited
  limited: limited
  minor: marginal
• salary_type: salary; possible options:
  none: no information
  value: value
  range: range of salary
  text: text
• salary_value: amount of salary, if salary_type is set to value
• salary_min_value: amount salary minimum, if salary_type is set to range
• salary_max_value: amount salary maximum, if salary_type is set to range
• salary_value_type: Salary type. Possible options:
  gross: gross
  net: net
• formatted_salary: salary information formatted as text, if available
• entry_date_type: entry date; possible options:
  none: no information
  immediately: immediately
  arrangement: according to arrangement
  date: effective date
• entry_date: entry date, if entry_date_type is set to date
• background_image_url: background image of job offer
• contact_person: name of contact person (optional)
• contact_phone: phone number of contact person (optional)
• contact_email: email adress of contact person (optional)
• reference: reference number of the job advertisement (optional)

Example response of the interface:

[
  {
    "id": "KeN07w4q",
    "languages": ["de", "it"],
    "types": ["full_time"]
    "published_at": "2021-02-26",
    "url": "https://demo.onboard.org/de/jobs/KeN07w4q",
    "form_url": "https://demo.onboard.org/jobs/KeN07w4q/form?show_logo=true",
    "title": "Costumer Service (m/w)",
    "description": "\u003ch3\u003eBeschreibung\u003c/h3\u003e\n\u003cp style=\"text-align: justify;\"\u003eBeispieltext: Lorem ipsum dolor sit amet.\u003c/p\u003e",
    "business": { "id": "XQmwJ3e9", "subdomain": "demo", "title_de": "Looptec New Media", "title_it": "Looptec New Media" },
    "locations": [{"id": 677, "name_de": "Bozen", "name_it": "Bolzano" }],
    "departments": [{"id": 1276, "name_de": "Produktion", "name_it": "Produzione"}]
  }
]