Interface (API) for querying the candidate data

Hired candidates in onboard can be queried via a JSON interface.

API Endpoints

The endpoint is accessible via the following URLs:

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

Header

• API-KEY: Mandatory for authorization. You can get the API key from our support team on request.

Parameters

• page: Displayed page. Begins at 1.

Example:

https://<company>.onboard.org/de/exports/v2/applications.json?page=1

Content

The interface contains the required information for the application:

• id: unique ID
• first_name: first name
• last_name: surname
• email: email adress
• phone: phone number

The data may contain additional or customized information about the employee, as this is configured individually for each interface.

Example response:

{
  "entries": [{
    "id": "KeN07w4q",
    "first_name": "Max",
    "last_name": "Mustermann",
    "country": "IT"
  }],
  "current_page": 1,
  "per_page": 30,
  "total_entries" 1
}