Schnittstelle (API) zur Abfrage der Bewerberdaten

Eingestellte Bewerber in onboard können über eine JSON-Schnittstelle abgefragt werden.

API-Endpunkt

Der Endpunkt ist über folgende URLs erreichbar:

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

Header

• API-KEY: Verpflichtend für die Autorisierung. Sie erhalten den API-Key von unserem Support-Team auf Anfrage.

Parameter

• page: Angezeigte Seite. Beginnt bei 1.

Beispiel:

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

Inhalt

Die Schnittstelle enthält die benötigten Informationen zur Bewerbung:

• id: Eindeutige ID
• first_name: Vorname
• last_name: Nachname
• email: E-Mail-Adresse
• phone: Telefonnummer

Evtl. enthalten die Daten zusätzliche bzw. angepasste Informationen zum Mitarbeiter, da diese individuell pro Schnittstelle konfiguriert werden.

Beispiel-Antwort:

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