Skip to main content
POST
/
api
/
ashby
/
jobs
/ashby/jobs
curl --request POST \
  --url https://api.anysite.io/api/ashby/jobs \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "board_name": "<string>",
  "posting_id": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "@type": "@ashby_job",
    "title": "<string>",
    "department": "<string>",
    "team": "<string>",
    "location": "<string>",
    "employment_type": "<string>",
    "workplace_type": "<string>",
    "is_remote": true,
    "is_listed": true,
    "should_display_compensation": true,
    "published_at": "<string>",
    "apply_url": "<string>",
    "job_url": "<string>",
    "address": {
      "@type": "@ashby_location",
      "location": "<string>",
      "region": "<string>",
      "country": "<string>",
      "locality": "<string>"
    },
    "secondary_locations": [],
    "compensation": {
      "@type": "@ashby_compensation",
      "summary": "<string>",
      "salary_summary": "<string>",
      "summary_components": [],
      "tiers": []
    },
    "description_html": "<string>",
    "description_plain": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
board_name
string
required

Company job-board handle from the careers URL

Minimum string length: 1
Examples:

"Ramp"

"Notion"

"Linear"

posting_id
string
required

Job posting identifier. Accepts a bare posting id or a full posting URL

Minimum string length: 1
Examples:

"d3bc1ced-3ce4-4086-a050-555055dbb1ff"

"https://jobs.ashbyhq.com/Linear/d3bc1ced-3ce4-4086-a050-555055dbb1ff"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
@type
string
default:@ashby_job
title
string | null
department
string | null
team
string | null
location
string | null
employment_type
string | null
workplace_type
string | null
is_remote
boolean | null
is_listed
boolean | null
should_display_compensation
boolean | null
published_at
string | null
apply_url
string | null
job_url
string | null
address
AshbyLocation · object
secondary_locations
AshbyLocation · object[]
compensation
AshbyCompensation · object
description_html
string | null
description_plain
string | null