v1 · Public REST API

Build on top of your
HireFlock data.

A simple, company-scoped REST API for accessing your Job Profile and Application data programmatically. Authenticate with an API key and connect HireFlock to your own systems in minutes.

Read the docs → Get an API key

Terminal

curl https://api.hireflock.ai/v1/job-profile \
  -H "Authorization: Bearer hf_live_your_key_here"

Why developers like it

A clean API, built the way you'd expect.

Predictable, secure, and stable. Everything you need to integrate HireFlock and nothing you don't.

API-key authentication

Create and revoke keys from the HireFlock dashboard. Send them as a Bearer token or x-api-key header.

Company-scoped

Every key only ever sees its own company's data. No cross-tenant access, ever.

Predictable responses

Consistent JSON envelopes, clear error codes, and simple page-based pagination.

Rate limited & stable

Per-key rate limiting and a versioned /v1 surface you can rely on.

Endpoints

Job Profile and Application.

Paths match the HireFlock app. Full reference lives in the interactive docs.

GET /v1/job-profile List your company's job profiles, newest first.

POST /v1/job-profile Create a job profile posting.

GET /v1/job-profile/{id} Fetch a single job profile by id.

PUT /v1/job-profile/{id} Update a job profile posting.

DELETE /v1/job-profile/{id} Delete a job profile posting.

GET /v1/job-profile/{id}/application List applications for a job profile.

POST /v1/job-profile/{id}/invite Invite a candidate to apply (optional custom message).

GET /v1/job-profile/{id}/question List interview questions for a job profile.

POST /v1/job-profile/{id}/question Create a question (Parts 1–4).

POST /v1/application/{id}/invite-video Invite an applicant to the video interview.

GET /v1/application List all applications across your job profiles.

GET /v1/application/{id} Fetch a single application by id.

PATCH /v1/application/{id} Update an application's review status.

GET /v1/candidate List candidates who applied to your jobs.

POST /v1/import/upload Upload resumes into the import pipeline.

GET /v1/skill Read the global skill catalog.

GET /health Liveness check (no auth).

Build on top of yourHireFlock data.