Getting Started

Quick overview of authentication, core data objects, and pagination behavior.

Authentication

API keys are required for all public API endpoints.

Pass the key using the x-api-key header.

Data Objects

Jobs

Active and recently expired postings. Includes core job fields like title, description, location, source, and apply URL, plus metadata for filtering.

Archived Jobs

Older expired postings retained for historical analysis. Shape mirrors Jobs but data is no longer actively refreshed.

Companies

Employers and organizations linked to postings. Use company endpoints to discover related jobs, locations, and identifiers.

Pagination

List endpoints return paged results using query parameters that control size and offset. Use the provided pagination metadata to request the next page.

A typical flow is: request page 1 with a limit, read total count, then increment the page/offset until all results are fetched.

API Base URL

The public API is served from the base path /api/v1.

The OpenAPI spec is available at /openapi.jsonand the interactive docs live at /docs.

Quick Examples

List jobs

curl \
  -H "x-api-key: YOUR_KEY" \
  "/api/v1/jobs?limit=25&includeExpired=false"

Get a single job

curl \
  -H "x-api-key: YOUR_KEY" \
  "/api/v1/jobs/{jobId}"

List companies

curl \
  -H "x-api-key: YOUR_KEY" \
  "/api/v1/companies?limit=25"

Get a single company

curl \
  -H "x-api-key: YOUR_KEY" \
  "/api/v1/companies/{companyId}"

Paginate jobs with cursor

curl \
  -H "x-api-key: YOUR_KEY" \
  "/api/v1/jobs?limit=50&cursor={nextCursor}"

Use the pagination.nextCursor value from the previous response.