Skip to content
Docs
Company careers

Careers board detection

The applicant-tracking system and board behind a URL, no jobs.

POST/v1/careers/detect
1 creditTry it

A job-board URL is parsed without any request. Otherwise the careers page is read (direct, every redirect DNS-validated) and scanned for embedded or linked boards — links, iframes, the Greenhouse embed script, URLs inside the page's JSON state, a Recruitee custom domain's own subdomain — following at most two same-site careers links when the first page has none. The board seen most often is company; other boards the page also linked are candidates. A page that names no board (or refuses this client) falls back to the board named after the company's domain on Greenhouse or Ashby, taken only when that ATS says it belongs to the same company (detected_by: domain, with meta.board_probes). Nothing found is a 422 listing the supported ATSs.

Request

POSThttps://api.scrapercompany.com/v1/careers/detect

Authenticate with your API key in the x-api-key header (see Authentication).

Body

JSON object. Unknown fields are rejected with 422.

  • urlstringrequiredmin length 4, max length 2048

    The company's careers page or its job-board URL. Paste https://www.figma.com/careers/ or https://boards.greenhouse.io/figma alike: the API finds the applicant-tracking system (Greenhouse, Lever, Ashby, Workable, SmartRecruiters, Workday, Recruitee, Personio) and the board internally; there is no ATS selector.

Example request

curl -X POST "https://api.scrapercompany.com/v1/careers/detect" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://linear.app/careers"
  }'

Response

200 — The applicant-tracking system and board behind a careers page. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response
{
  "search_parameters": {
    "engine": "careers_detect",
    "url": "https://linear.app/careers"
  },
  "company": {
    "ats": "ashby",
    "board": "Linear",
    "board_url": "https://jobs.ashbyhq.com/Linear"
  },
  "detected_by": "page",
  "candidates": [],
  "meta": {
    "pages_fetched": 1,
    "elapsed_s": 0.214
  }
}

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}
No, fix the request
402Payment Required

Not enough credits for this request. Only returned once credit enforcement is switched on; during the beta metering runs in shadow mode and never blocks.

{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}
No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}
No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (once credit enforcement is on) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}
Yes, with backoff
502Bad Gateway

The upstream source failed, blocked the request or returned an unusable answer. Safe to retry later; failed requests are not charged.

{"detail":"RuntimeError"}
Yes, with backoff
503Service Unavailable

Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later.

{"detail":"database unavailable: OperationalError"}
Yes, with backoff

Try it

The quickest way: open this endpoint in Try it. It runs on your account with the example request filled in, shows the cost before you run, and shows the answer as a readable table next to the JSON and the code. Signed out? You sign in first and come straight back.

  1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? request access).
  2. Copy the cURL example above and run it in a terminal.
  3. Or open the interactive playground on api.scrapercompany.com, paste your key and pick this endpoint.

Credits

1 credit per successful call. Failed, blocked and empty results are free. Credit metering is in beta and does not block requests yet.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support