Schnittstelle zur Abfrage der Dokumente

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

API-Endpunkt

Der Endpunkt ist über folgend URL erreichbar:

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

Inhalt

Die Schnittstelle liefert folgende Inhalte:

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

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

• id: ID des Dokuments
• employee_id: ID des Mitarbeiters
• file_url: URL zum Dokument (Link ist eine Woche gültig)
• date: Datum des Dokuments
• display_name: Anzeigename des Dokuments
• employee_file_category_id: ID des Ordners (kann separat abgefragt werden)
• created_at: Erstellungsdatum im Format ISO 8601
• updated_at: Änderunungdatum im Format ISO 8601

Beispiel-Antwort:

{
   "entries":[
      {
         "id": 3,
         "employee_id: "RGb11O42",
         "file_url": "https://onboard-live.s3.eu-west-1.amazonaws.com/uploads/employee_file/file/ABC123/file.pdf?X-Amz-Signature=1234567890",
         "date": "2023-02-01",
         "display_name": "Lebenslauf",
         "employee_file_category_id": 738,
         "created_at":"2021-10-13T10:03:45.853Z",
         "updated_at":"2021-10-13T10:03:45.853Z"
      }
   ],
   "current_page":1,
   "per_page":30,
   "total_entries":1
}