REST API

De PeekHire REST API laat je eigen software werken met je wervingsdata. Het is een standaard HTTPS + JSON API, zodat elke taal of tool die webverzoeken kan doen deze kan gebruiken.

Bekijk elk endpoint, elke parameter en elk schema in de interactieve OpenAPI-referentie:

Basis-URL en versiebeheer

De API is geversioneerd. Alle endpoints staan onder de prefix /api/v1, zodat toekomstige wijzigingen je integratie niet kapotmaken.

Authenticatie

Gebruik voor elk verzoek authenticatie met een API-sleutel die wordt meegestuurd als bearer-token:

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

Neem nooit een API-sleutel op in client-side code of een openbare repository.

Waar je toegang toe hebt

De v1 API dekt de belangrijkste wervingsobjecten:

• Campagnes — bekijk een lijst met de functies waarvoor je werft en haal ze op.
• Sollicitaties — bekijk een lijst met kandidaat-inzendingen en haal ze op.
• Gebruikers — bekijk een lijst met leden van je werkruimte en haal ze op.

Responses zijn JSON en bevatten de velden die je in de app ziet, zoals de titel en status van een campagne of de fase en taal van een sollicitatie.

Paginering en filtering

Lijst-endpoints geven resultaten terug in pagina’s. Gebruik de pagineringsparameters om door grote resultatensets te bladeren en filter waar dit wordt ondersteund om alleen op te halen wat je nodig hebt.

Fouten

De API gebruikt standaard HTTP-statuscodes — 2xx voor succes, 4xx voor problemen met je verzoek (zoals een ontbrekende of ongeldige sleutel) en 5xx voor onverwachte serverfouten. Foutresponses bevatten een bericht dat beschrijft wat er misging.

Gerelateerd

• API-sleutels
• Webhooks voor pushmeldingen in plaats van polling