Skip to main content

1. Get a key

Sign in to the dashboard and go to Settings → API Keys. The key is shown once, so store it straight away.

2. Make a request

Search for software engineering jobs and take the first five results.

3. Read the response

Results come back in a jobs array with pagination metadata and a facets object. This example is abridged — a real job carries about 25 fields.
Four things worth noticing immediately: See The job object for every field, its type, and its nullability.

Filter the results

Filters are matched literally, so send canonical values — remote, not Remote; senior, not senior level.
An unknown parameter is ignored and an unknown value matches nothing — neither is an error. A typo returns a plausible-looking 200, so check total when a filter seems to have done nothing. There is no is_remote parameter; use work_model. See silent failures.
Search recipes has working combinations for every filter.

Try it without spending

Three endpoints are free, so you can build against them without touching your wallet:
  • GET /api/jobs/{id} — re-fetch a single job
  • GET /api/jobs/expired — ids that recently expired
  • GET /api/companies/{id} — a full company profile, and it needs no API key at all
See Billing for what the metered endpoints cost.

Next

Core concepts

Freshness, job identity, and the 7-day expiry window that catches most integrations out.

Sync a database

The flagship pattern — backfill, then incremental sync with expiry sweeps.

Search recipes

Working filter combinations, relevance behaviour, facets, and field selection.

API reference

Every endpoint, with request and response schemas.