GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

🧠 Search Jobs indexed in Boards

This endpoint allows you to Search Jobs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request headers

FieldValue
X-API-KEYYour API Key.
X-USER-EMAILYour HrFlow.ai account's email.
🚧

Request Method Selection

This endpoint supports both GET and POST. When query parameters exceed the maximum allowed URL length, clients should use the POST variant and send the same parameters in the request body (see the changelog).

Query Params
string
required

The list of the keys of the Boards containing the targeted Jobs. Example: ["xxx", "yyy", "zzz"].

string

Include only Jobs matching the given list of Job keys. When provided, the results are restricted to this subset. Example : ["xxx", "yyy", "zzz"]

string

Exclude Jobs according to the list of Job keys. Example : ["xxx", "yyy", "zzz"]

string

Filter Jobs by the tracking activity recorded with a given Profile: only Jobs having at least one tracking whose action is in the list are returned. Example: ["applied", "interviewed", "hired"]

string
Defaults to 1

The number of the current results' page.

string
Defaults to 30

The number of results per page

string
enum
Defaults to desc

Order results by asc, or desc.

Allowed:
string
enum
Defaults to created_at

Sort results by searching, created_at, updated_at, location, location_experience, location_education.

Allowed:
string

Set a minimum creation date. Example: 2023-06-01T00:00:00.000Z

string

Set a maximum creation date. Example: 2023-09-01T00:00:00.000Z

string

Filter Jobs by their names. Example: ["xxx", "yyy", "zzz"].

string

Filter Jobs by their location address. Example: {"lat":47.21812, "lng":-1.55306}

int32

Set a radius around the Jobs' location address (in Km).

string

Filter Jobs by keywords in their summary section. Example: ["xxx", "yyy", "zzz"].

string

Filter Jobs by keywords in the full text. Example: ["xxx", "yyy", "zzz"]

boolean
Defaults to false

If enabled, this feature enriches the search by including synonyms of the keywords specified in text_keywords, broadening the search results.

string

Filter results by a list of skills names and their values. Example: [{"name":"python", "value":null}]

string

Filter results by a list of languages names and their values. Example: [{"name":"english", "value":null}]

string

Filter results containing certain tag names and their values. Shape of this field [ [... OR ...] AND [... OR ...] ]. Example : [[{"name":"sync","value":"1"}]]

string

Exclude results containing certain tag names and their values. Shape of this field [ [... OR ...] AND [... OR ...] ]. Example : [[{"name":"sync","value":"0"}]]

string

Filter jobs on their ranges_float, with the same shape and rules as ranges_number: a job matches when one of its ranges of that name overlaps the requested one, even partly. Example: [{"name": "salary", "value_min": 1234.56, "value_max": 6543.21}]

string

Filter jobs on the number ranges their Boards declare. A JSON list of {"name", "value_min", "value_max"}: all three keys are required, and null leaves an end open. A job matches when one of its ranges of that name overlaps the requested one, even partly. Ranges of different names must all match; several ranges of one name are alternatives. Add "relation": "within" to a range to keep only the jobs whose range lies inside it, or "relation": "contain" for those whose range covers it ("overlap" is the default). Example: [{"name": "Salary", "value_min": 45000, "value_max": 55000}]

string

Filter jobs on their date ranges (ranges_date, and the date ranges their Boards declare), with the same shape and rules as ranges_number; bounds are ISO 8601 dates, with or without a colon in their offset. Example: [{"name":"Dates","value_min":"2020-05-18T21:59","value_max":"2020-09-15T21:59"}]

string

Filter results based on custom raw query.
Example: {"query":{"bool":{"should":[{"match":{"summary":"python"}},{"match":{"summary":"machine learning"}}]}}}

facets
array of strings

List of fields to return facet counts for (e.g. ["skills","languages"]). A non-empty value returns aggregated counts under meta and no ranked jobs. ranges returns a histogram of each range the Boards declare: number ranges in meta.numeric_facets (min, max, count, and buckets of equal width with their min, max and count), date ranges in meta.date_facets (interval, and calendar buckets with their key, key_as_string and count). A bucket's count is the number of jobs a filter on that bucket returns, with the filters of the request, its own range's included.

facets
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json