Skip to main content
POST
job.postings.search-export

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
titlesInclude
string[]

Job titles to export, any of, e.g. DevOps Engineer.

Maximum array length: 20
Required string length: 1 - 256
titlesExclude
string[]

Job titles to exclude.

Maximum array length: 20
Required string length: 1 - 256
titleVector
boolean

True to match titles by meaning as well as wording.

companiesInclude
string[]

Company domains to export, any of, e.g. figma.com.

Maximum array length: 50
Required string length: 1 - 64
companiesExclude
string[]

Company domains to exclude.

Maximum array length: 50
Required string length: 1 - 64
countries
string[]

Two-letter country codes like US, any of.

Maximum array length: 50
Required string length: 1 - 64
regions
string[]

Regions like EMEA or North America, any of.

Maximum array length: 50
Required string length: 1 - 64
states
string[]

State or region names or codes, any of.

Maximum array length: 50
Required string length: 1 - 64
cities
string[]

City names, any of.

Maximum array length: 50
Required string length: 1 - 64
tagsInclude
string[]

Skills or topics the job mentions, any of, e.g. kubernetes.

Maximum array length: 50
Required string length: 1 - 256
tagsExclude
string[]

Skills or topics to exclude.

Maximum array length: 50
Required string length: 1 - 256
salaryMinUsd
integer

Minimum annual salary in US dollars.

Required range: 0 <= x <= 9007199254740991
salaryMaxUsd
integer

Maximum annual salary in US dollars.

Required range: 0 <= x <= 9007199254740991
postedWithinDays
integer

Only jobs posted in the last N days, 1 to 365.

Required range: 1 <= x <= 365
includeDescription
boolean

True to include the full posting text with each job; larger and slower.

maxRows
integer
default:100

How many jobs to export, 1 to 1000. Default 100. The source documents up to 5,000 per run, but a response that large does not fit the time a run has, so this capability caps at 1000; run a narrower search again for more. Every exported job is billed, so ask for only what you need.

Required range: 1 <= x <= 1000

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.