REST API

PeekHire REST API lar din egen programvare jobbe med rekrutteringsdataene dine. Det er en standard HTTPS + JSON API, så alle språk og verktøy som kan sende webforespørsler kan bruke den.

Utforsk alle endepunkter, parametere og skjemaer i den interaktive OpenAPI-referansen:

Grunn-URL og versjonering

API-en er versjonert. Alle endepunkter ligger under prefikset /api/v1, slik at fremtidige endringer ikke bryter integrasjonen din.

Autentisering

Autentiser hver forespørsel med en API-nøkkel sendt som en bearer token:

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

Bygg aldri inn en API-nøkkel i klientkode eller et offentlig repository.

Hva du kan få tilgang til

v1 API-en dekker de viktigste rekrutteringsobjektene:

• Kampanjer — list opp og hent rollene du rekrutterer til.
• Søknader — list opp og hent kandidatinnsendinger.
• Brukere — list opp og hent medlemmer av arbeidsområdet ditt.

Svar er JSON og inkluderer feltene du ser i appen, for eksempel en kampanjes tittel og status eller en søknads steg og språk.

Paginering og filtrering

Listeendepunkter returnerer resultater i sider. Bruk pagineringsparameterne for å bla gjennom store resultatsett, og filtrer der det støttes for å hente bare det du trenger.

Feil

API-en bruker standard HTTP-statuskoder — 2xx for vellykket, 4xx for problemer med forespørselen din (for eksempel en manglende eller ugyldig nøkkel), og 5xx for uventede serverfeil. Feilsvar inkluderer en melding som beskriver hva som gikk galt.

Relatert

• API-nøkler
• Webhooks for push-varsler i stedet for polling