Interface (API) for querying the locations

The locations of onboard can be queried via a JSON interface.

API Endpoints

The endpoint is accessible via the following URLs:

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

Additionally there are own 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/locations.json

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

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

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

Parameters

• visible_on_career_site: displays only the locations visible on the career page. The value can be true or false .
• only_roots: displays only the top-level locations. The value can be true or false ein.
• subtree_id: displays only the overlapping locations and its subdivisions.
• descendants_of_id: displays only the subdivisions of the top-level locations.
• children_of_id: displays only the direct subdivisions of the overlapping locations.

Example:

https://<company>.onboard.org/de/exports/v2/locations.json?show_on_career_site=true

Content

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

• id: unique ID
• name: name of location
• postal_code: postal code (ZIP Code)
• country: land-ISO-Code (z.B. “IT”)
• depth: level or depth in the hierarchy (starts at 0).
• subtree_ids: list of IDs of all included locations
• ancestor_id: ID of the higher-ranking locations
• is_sub_business: true if the location is a sub-business, false if not.
• sub_business_title: Name of the sub-business (if the location is one).

Example response of the interface:

[
  {
    "id": 123,
    "name": "Hauptsitz Lana",
    "street":"Boznerstraße 15/11",
    "postal_code": "39011",
    "city": "Lana",
    "region": "BZ",
    "country": "IT",
    "depth": 0,
    "subtree_ids": [123, 456],
    "ancestor_id": null,
    "is_sub_business": false,
    "sub_business_title": ""
  },
  {
    "id": 456,
    "name": "Online-Marketing",
    "street":"Enrico-Fermi-Straße 20",
    "postal_code": "39100",
    "city": "Bozen",
    "region": "BZ",
    "country": "IT",
    "depth": 1,
    "subtree_ids": [456],
    "ancestor_id": 123,
    "is_sub_business": true,
    "sub_business_title": "Sub-Unternehmen"
  }
]