Schnittstelle (API) zur Abfrage der Mitarbeiterdaten

Die Mitarbeiterdaten von onboard können über eine JSON-Schnittstelle abgefragt werden.

API-Endpunkt

Der Endpunkt ist über folgende URL erreichbar:

https://<Unternehmen>.onboard.org/exports/v2/employees.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/employees.json?page=1

Inhalt

Die Schnittstelle liefert folgende Inhalte:

• entries: Mitarbeiter-Informationen
• current_page: Aktuelle Seite
• per_page: Angezeigte Einträge pro Seite
• total_entries: Gesamtanzahl an Einträgen

Die Informationen der Mitarbeiter enthalten die Stammdaten sowie evtl. Informationen zum Anstellungsverhältnis:

• id: eindeutige ID in onboard
• gender: Geschlecht. Mögliche Werte:
  • unknown: nicht bekannt
  • male: männlich
  • female: weiblich
  • diverse: divers
  • not_defined: nicht gesetzt
• language: Sprache des Mitarbeiters im ISO 639-1-Format
• first_name: Vorname
• last_name: Nachname
• email: Private E-Mail-Adresse
• company_email: Firmen E-Mail-Adresse
• phone: Private Telefonnummer
• company_phone: Firmen Telefon
• birthday: Geburtsdatum im Format YYYY-MM-DD
• tax_number: Italienische Steuernummer
• employee_number: Personalnummer
• nationality: Nationalität als Land-ISO-Code (z.B. „IT“)
• birthplace: Geburtsort
• street: Wohnort – Straße
• street_number: Wohnort – Hausnummer
• city: Wohnort – Stadt
• postal_code: Wohnort – Postleitzahl
• region: Wohnort – Region bzw. Bezirk
• country_code: Wohnort – Land als Land-ISO-Code (z.B. „IT“)
• iban: IBAN
• swift: BIC/SWIFT
• hired_at: Eintrittsdatum im Format YYYY-MM-DD. Wenn es noch kein Eintrittsdatum gibt, kann der Wert null sein.
• leaving_at: Austrittsdatum im Format YYYY-MM-DD. Wenn der Mitarbeiter unbefristet angestellt ist oder es kein Austrittsdatum gibt, kann der Wert null sein.
• employee_status_id: ID des Status
• location_id: ID des Standorts
• department_id: ID der Abteilung
• supervisor_id: ID des*der Vorgesetzte*n
• created_at: Erstellungsdatum im Format ISO 8601
• updated_at: Letzte Aktualisierung im Format ISO 8601
• photo_url: URL zum Foto des Mitarbeiters (Original)
• photo_url_big: URL zum Foto des Mitarbeiters (400x400px)
• photo_url_default: URL zum Foto des Mitarbeiters (80x80px)

Bestimmte Werte sind optional. Ggf. enthält die Schnittstelle zusätzliche Felder (je nach Einstellungen des Unternehmens).

Beispiel-Antwort:

{
   "entries":[
      {
         "id":"RGb11O42",
         "email":"support@onboard.org",
         "first_name":"Max",
         "last_name":"Mustermann",
         "phone":null,
         "created_at":"2021-10-13T10:03:45.853Z",
         "updated_at":"2021-10-13T10:03:45.853Z",
         "language":"de",
         "gender":"unknown",
         "employee_status_id":4,
         "location_id":77,
         "department_id":9
      }
   ],
   "current_page":1,
   "per_page":30,
   "total_entries":1
}