/ashby/jobs

POST /api/ashby/jobs

Price: 20 credits

Get a single Ashby job posting by board handle and posting id

How to use it

Get full details of one job posting from a company's Ashby career board. Provide the board handle and the posting id (a bare id or a full posting URL is accepted). Returns title, department, team, location and secondary locations, employment type, workplace type, remote flag, publish date, apply and posting URLs, full HTML and plain-text descriptions, and structured compensation tiers.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• board_name string required — Company job-board handle from the careers URL (examples: "Ramp", "Notion", "Linear"; minLength: 1)
• posting_id string required — Job posting identifier. Accepts a bare posting id or a full posting URL (examples: "d3bc1ced-3ce4-4086-a050-555055dbb1ff", "https://jobs.ashbyhq.com/Linear/d3bc1ced-3ce4-4086-a050-555055dbb1ff"; minLength: 1)

Response

• @type string (default: "AshbyJob")
• id string required
• department string nullable
• team string nullable
• location string nullable
• employment_type string nullable
• workplace_type string nullable
• is_remote boolean nullable
• is_listed boolean nullable
• should_display_compensation boolean nullable
• published_at string nullable
• apply_url string nullable
• job_url string nullable
• address object nullable
  • @type string (default: "AshbyLocation")
  • location string nullable
  • region string nullable
  • country string nullable
  • locality string nullable
• secondary_locations array (default: [])
  • @type string (default: "AshbyLocation")
  • location string nullable
  • region string nullable
  • country string nullable
  • locality string nullable
• compensation object nullable
  • @type string (default: "AshbyCompensation")
  • summary string nullable
  • salary_summary string nullable
  • summary_components array (default: [])
    • @type string (default: "AshbyCompensationComponent")
    • summary string nullable
    • compensation_type string nullable
    • interval string nullable
    • currency_code string nullable
    • min_value number nullable
    • max_value number nullable
  • tiers array (default: [])
    • @type string (default: "AshbyCompensationTier")
    • id string nullable
    • summary string nullable
    • additional_information string nullable
    • components array (default: [])
• description_html string nullable
• description_plain string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Job board or posting not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.