API reference

Routes, filters and response fields for the Jobs API.

API REFERENCE

Get started with Headcount Labs

Choose a workflow, check account and API access, then prepare and interpret a source-documented request.

Read guide
API REFERENCE

Authentication

Send the source-supported bearer token in the Authorization header and keep credentials server-side.

Read guide
API REFERENCE

API reference

Index of public API routes and their current implementation status.

Read guide
API REFERENCE

Jobs endpoints

Methods, query behavior, response differences, and change retrieval for jobs.

Read guide
API REFERENCE

Companies endpoints

List and search the registry, read a company, and page jobs by canonical company ID.

Read guide
API REFERENCE

Job filters

See how source-supported text, location, posting, date, pay, and representation options shape a jobs request.

Read guide
API REFERENCE

Pagination and cursors

Understand the distinct continuation rules for jobs, companies, and usage reports.

Read guide
API REFERENCE

Errors and response headers

Interpret structured errors, status mappings, usage headers, and conditional rate-limit metadata.

Read guide
API REFERENCE

Job and posting fields

Understand combined job IDs, posting IDs, state-bearing values, and the difference between list and detail DTOs.

Read guide
API REFERENCE

Search and location filters

Use the implemented jobs filters accurately and keep query parsing separate from query execution.

Read guide
API REFERENCE

Currentness, status, and changes

Separate currentness, stale state, source posting status, application checks, and change-feed events.

Read guide
API REFERENCE

Plan a safe data sync

Use stable request scope, idempotent writes, and explicit restart behavior with changes.

Read guide
API REFERENCE

Company data

Read the compact company registry and understand canonical IDs, merge redirects, and company-scoped job listing.

Read guide
API REFERENCE

ATS pages and job boards

Understand source identity in the API without assuming that platform names or posting URLs are company IDs.

Read guide
API REFERENCE

Source values and derived values

Read state envelopes and keep source-preserved posting data distinct from normalized public fields.

Read guide
API REFERENCE

Counts and returned records

Separate result rows, distinct combined jobs, admitted requests, and returned-record usage units.

Read guide
API REFERENCE

Timestamps and currentness

Interpret source dates, observation dates, projection timestamps, and currentness without implying a refresh SLA.

Read guide
API REFERENCE

Usage reporting endpoints

Read the authenticated request ledger and daily aggregates; understand their filters, cursors, and time basis.

Read guide
API REFERENCE

Usage and limits

Per-customer request limits, how returned records are counted, and how plans set your allowance.

Read guide