Search jobs.

GET

/v1/jobs/search

Authorizations

• BearerApiKey

Parameters

Query Parameters

keywords

required

string

>= 1 characters <= 500 characters

Example

software engineer

start

integer

0 <= 10000

Example

0

location

A location ID from Location search (data.locations[].id).

string

/^geo_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/

Example

geo_6yITcz

companyIds

Filter by company. Use IDs from Company details (data.publicId), separated by commas. Jobs at any of the companies match. Find companies with Company search.

string

>= 1 characters <= 1099 characters

Example

company_4T4tWj

experience

string

Allowed values: internship entry associate mid_senior director executive

Example

mid_senior

sort

string

default: relevance

Allowed values: relevance recent

Example

relevance

timePosted

string

default: any

Allowed values: any day week month

Example

any

employmentType

Employment types: full_time, part_time, contract, temporary, volunteer, internship, or other. Separate types with commas.

string

>= 1 characters <= 1099 characters

Example

part_time,contract

workplaceType

Workplace types: on_site, remote, or hybrid. Separate types with commas.

string

>= 1 characters <= 1099 characters

Example

remote,hybrid

easyApply

Set to true to show only Easy Apply jobs. Otherwise, omit this filter.

string

Allowed value: true

Example

true

under10Applicants

Set to true to show only jobs with fewer than 10 applicants. Otherwise, omit this filter.

string

Allowed value: true

Example

true

Responses

200

The requested data.

Media typeapplication/json

object

data

required

object

jobs

required

Array<object>

<= 100 items

object

title

required

string

url

required

string

location

required

Any of:

string

string

null

null

postedAt

required

Any of:

string

string format: date-time

/^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])[Tt]([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(?:\.[0-9]+)?(?:[Zz]|\+00:00)$/

null

null

companyName

required

Any of:

string

string

null

null

companyUrl

required

Any of:

string

string

null

null

companyLogoUrl

required

Any of:

string

string format: uri

>= 1 characters <= 11000 characters

null

null

isPromoted

required

Whether the job is marked Promoted.

boolean

isEasyApply

required

Whether the job offers Easy Apply.

boolean

meta

required

object

paging

required

object

start

required

integer

<= 10000

count

required

integer

>= 1 <= 100

hasMore

required

boolean

creditCost

required

integer

<= 9007199254740991

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

Errors

Every error returns the same body. The status and error.code tell you what went wrong. The Errors guide covers handling and retries.

Body

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request invalid_api_key insufficient_credits insufficient_scope account_suspended resource_not_found method_not_allowed not_acceptable unsupported_media_type rate_limit_exceeded internal_error response_too_large upstream_error service_unavailable upstream_timeout

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

Status	error.code	Meaning
400	invalid_request	A parameter is missing or has a value we cannot use. Read error.details, fix the value and try again.
401	invalid_api_key	Your API key is missing, wrong or switched off. Check it in your dashboard.
402	insufficient_credits	Your account has no credits left. Top up, then send a new call. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
403	insufficient_scope, account_suspended	Your account is suspended or cannot use this endpoint. Resolve the account or its access first.
404	resource_not_found	Nothing matched what you sent. Check it for typos. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
405	method_not_allowed	The route exists, but the request used a method other than GET. Use the method shown at the top of this page. Also sends Allow.
406	not_acceptable	The Accept header asks for a format we do not send. Ask for JSON with a supported Accept value.
415	unsupported_media_type	The request declared a media type we do not accept. Remove the body or use the documented media type.
429	rate_limit_exceeded	Too many calls in a short time. Honor Retry-After; use bounded retries with backoff and jitter. Also sends X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, Retry-After.
500	internal_error, response_too_large	Something failed on our side. Retry only when error.retryable is true. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
502	upstream_error	A data source sent back something we could not use. Retry with bounded backoff. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
503	service_unavailable	Lookups are unavailable for a moment. Follow error.retryable, and Retry-After when it is present. Also sends Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Credits-Remaining.
504	upstream_timeout	The lookup ran out of time. Retry with bounded backoff. Also sends X-Credits-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.