REST API

PeekHire REST API lader din egen software arbejde med dine rekrutteringsdata. Det er en standard HTTPS + JSON-API, så alle sprog eller værktøjer, der kan lave web requests, kan bruge den.

Udforsk alle endpoints, parametre og schemaer i den interaktive OpenAPI-reference:

Basis-URL og versionsstyring

API'en er versionsstyret. Alle endpoints ligger under præfikset /api/v1, så fremtidige ændringer ikke ødelægger din integration.

Godkendelse

Godkend hver request med en API-nøgle, der sendes som et bearer-token:

curl https://your-api-host/api/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

Indlejr aldrig en API-nøgle i kode på klientsiden eller i et offentligt repository.

Det kan du få adgang til

v1 API'en dækker de centrale rekrutteringsobjekter:

• Kampagner — få vist og hent de roller, du ansætter til.
• Ansøgninger — få vist og hent indsendelser fra kandidater.
• Brugere — få vist og hent medlemmer af dit arbejdsområde.

Svar er JSON og indeholder de felter, du ser i appen, såsom en kampagnes titel og status eller en ansøgnings fase og sprog.

Paginering og filtrering

Liste-endpoints returnerer resultater i sider. Brug pagineringsparametrene til at bladre gennem store resultatsæt, og filtrér, hvor det understøttes, for kun at hente det, du har brug for.

Fejl

API'en bruger standard HTTP-statuskoder — 2xx for succes, 4xx for problemer med din request (såsom en manglende eller ugyldig nøgle) og 5xx for uventede serverfejl. Fejlsvar indeholder en besked, der beskriver, hvad der gik galt.

Relateret

• API-nøgler
• Webhooks til push-notifikationer i stedet for polling