REST API

PeekHire REST API låter din egen programvara arbeta med dina rekryteringsdata. Det är ett standard-API med HTTPS + JSON, så alla språk eller verktyg som kan göra webbförfrågningar kan använda det.

Utforska varje endpoint, parameter och schema i den interaktiva OpenAPI-referensen:

Bas-URL och versionshantering

API:et är versionshanterat. Alla endpoints ligger under prefixet /api/v1 så att framtida ändringar inte bryter din integration.

Autentisering

Autentisera varje förfrågan med en API-nyckel som skickas som en bearer-token:

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

Bädda aldrig in en API-nyckel i kod på klientsidan eller i ett publikt repository.

Det du kan komma åt

v1 API täcker de centrala rekryteringsobjekten:

• Kampanjer — lista och hämta rollerna du rekryterar till.
• Ansökningar — lista och hämta kandidatinskick.
• Användare — lista och hämta medlemmar i din arbetsyta.

Svaren är JSON och innehåller fälten du ser i appen, till exempel en kampanjs titel och status eller en ansökans steg och språk.

Paginering och filtrering

List-endpoints returnerar resultat i sidor. Använd pagineringsparametrarna för att bläddra igenom stora resultatmängder, och filtrera där det stöds för att bara hämta det du behöver.

Fel

API:et använder standardiserade HTTP-statuskoder — 2xx för lyckade anrop, 4xx för problem med din förfrågan (till exempel en saknad eller ogiltig nyckel) och 5xx för oväntade serverfel. Felsvar innehåller ett meddelande som beskriver vad som gick fel.

Relaterat

• API-nycklar
• Webhooks för pushnotiser i stället för polling