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

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
country
enum<string>

Two-letter country code; GB means the United Kingdom.

Available options:
GB,
US,
AT,
AU,
BE,
BR,
CA,
CH,
DE,
ES,
FR,
IN,
IT,
MX,
NL,
NZ,
PL,
SG,
ZA
domain
string

Company domain for company-scoped postings.

keywords
string

General job search keywords.

Required string length: 1 - 2048
allWords
string

Every supplied word must match.

Required string length: 1 - 2048
phrase
string

Exact phrase in title or description.

Required string length: 1 - 2048
anyWords
string

At least one supplied word must match.

Required string length: 1 - 2048
excludeWords
string

Words excluded from title and description.

Required string length: 1 - 2048
titleOnly
string

Words that must all appear in the title.

Required string length: 1 - 512
where
string

Geographic search centre.

Required string length: 1 - 256
distanceKm
integer

Radius around where, in kilometres.

Required range: 1 <= x <= 1000
locationArea
string[]

Location hierarchy from broadest to narrowest, up to eight levels.

Required array length: 1 - 8 elements
Required string length: 1 - 256
location
string

Country or state name or abbreviation for observation searches.

Required string length: 1 - 256
category
string

Public category code.

Required string length: 1 - 128
categories
enum<string>[]

Observed posting categories.

Required array length: 1 - 30 elements
Available options:
administration,
consulting,
data_analysis,
design,
directors,
education,
engineering,
finance,
healthcare_services,
human_resources,
information_technology,
internship,
legal,
management,
marketing,
military_and_protective_services,
operations,
purchasing,
product_management,
quality_assurance,
real_estate,
research,
sales,
software_development,
support,
manual_work,
food
ageDays
integer

Maximum advertisement age in days.

Required range: 1 <= x <= 365
salaryMin
object

Minimum salary in the country's currency.

salaryMax
object

Maximum salary in the country's currency.

includeUnknownSalary
boolean

True to also include jobs with unknown salaries.

employmentTime
enum<string>

Required hours arrangement.

Available options:
full_time,
part_time
employmentType
enum<string>

Required employment arrangement.

Available options:
permanent,
contract
canonicalCompanyName
string

Canonical employer name from an earlier search.

Required string length: 1 - 256
sortBy
enum<string>

Requested ordering.

Available options:
default,
hybrid,
date,
salary,
relevance
sortDirection
enum<string>

Ascending or descending order.

Available options:
up,
down
occupationCodes
string[]

O*NET occupation codes to match.

Required array length: 1 - 50 elements
Required string length: 1 - 32
foundFrom
string

Only postings discovered after this date; this is not their placement time.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
seniority
enum<string>

Seniority inferred from the posting title, never a rating of a person.

Available options:
not_set,
founder,
c_level,
partner,
president,
vice_president,
head,
director,
manager,
mid_senior,
junior
includeRecruiter
boolean
default:false

Include hiring contact name, job title and contact details where supplied; default false.

activeOnly
boolean

True for recent active observations; false includes inactive records.

notClosed
boolean

True excludes explicitly closed postings without requiring recent observation.

firstSeenFrom
string

First observed after this date.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
firstSeenUntil
string

First observed before this date.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
lastSeenFrom
string

Last observed after this date.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
lastSeenUntil
string

Last observed before this date.

Required string length: 1 - 10
Pattern: ^\d{4}-\d{2}-\d{2}$
withDescriptionOnly
boolean

True requires a description.

withLocationOnly
boolean

True requires a location.

includeDescription
boolean
default:false

Include up to 10,000 characters of full posting text where available; default false.

limit
number

Up to 50 postings; default 10. Maximum source cost is USD 2 per page.

Required range: x >= 1
cursor
string

Opaque nextCursor from the previous page of this exact search.

Required string length: 1 - 1024

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.

total
integer

Total matches when supplied.

Required range: 0 <= x <= 9007199254740991
averageSalary
object

Mean salary across matches, in local currency.