REST-API

Mit der PeekHire REST-API arbeitet deine eigene Software mit deinen Recruiting-Daten. Es ist eine Standard-API über HTTPS + JSON – jede Sprache, die Web-Requests stellt, kann sie nutzen.

Entdecke jeden Endpunkt, Parameter und jedes Schema in der interaktiven OpenAPI-Referenz:

Basis-URL und Versionierung

Die API ist versioniert. Alle Endpunkte liegen unter dem Präfix /api/v1, damit künftige Änderungen deine Integration nicht brechen.

Authentifizierung

Authentifiziere jeden Request mit einem API-Key als Bearer-Token:

curl https://dein-api-host/api/v1/campaigns \
  -H "Authorization: Bearer DEIN_API_KEY"

Lege einen API-Key niemals in Client-Code oder einem öffentlichen Repository ab.

Worauf du zugreifst

Die v1-API deckt die zentralen Recruiting-Objekte ab:

• Campaigns – Stellen auflisten und abrufen.
• Applications – Bewerbungen auflisten und abrufen.
• Users – Mitglieder deines Workspace auflisten und abrufen.

Antworten sind JSON und enthalten dieselben Felder wie die App, etwa Titel und Status einer Kampagne oder Stage und Sprache einer Bewerbung.

Paginierung und Filter

Listen-Endpunkte liefern Ergebnisse seitenweise. Nutze die Paginierungs-Parameter für große Mengen und filtere, wo unterstützt, um nur das Nötige zu laden.

Fehler

Die API nutzt Standard-HTTP-Statuscodes – 2xx für Erfolg, 4xx für Probleme mit deinem Request (etwa fehlender Key), 5xx für unerwartete Serverfehler. Fehler-Antworten enthalten eine beschreibende Nachricht.

Verwandt

• API-Keys
• Webhooks für Push statt Polling