REST API

The PeekHire REST API lets your own software work with your recruiting data. It's a standard HTTPS + JSON API, so any language or tool that can make web requests can use it.

Explore every endpoint, parameter, and schema in the interactive OpenAPI reference:

Base URL and Versioning

The API is versioned. All endpoints live under the /api/v1 prefix so future changes won't break your integration.

Authentication

Authenticate every request with an API key sent as a bearer token:

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

Never embed an API key in client-side code or a public repository.

What You Can Access

The v1 API covers the core recruiting objects:

• Campaigns — list and retrieve the roles you're hiring for.
• Applications — list and retrieve candidate submissions.
• Users — list and retrieve members of your workspace.

Responses are JSON and include the fields you see in the app, such as a campaign's title and status or an application's stage and language.

Pagination and Filtering

List endpoints return results in pages. Use the pagination parameters to page through large result sets, and filter where supported to fetch only what you need.

Errors

The API uses standard HTTP status codes — 2xx for success, 4xx for problems with your request (such as a missing or invalid key), and 5xx for unexpected server errors. Error responses include a message describing what went wrong.

Related

• API keys
• Webhooks for push notifications instead of polling