GET: /jobs/searching

Retrieve a list of jobs based on given filters

get
Get /jobs/searching

https://api.hrflow.ai/v1/jobs/searching
This endpoint allows you to search jobs for given filters.
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token.
X-USER-EMAIL
required
string
User's email.
Query Parameters
board_keys
required
array
Only Jobs in these boards will be scored
limit
optional
integer
Total job to score, default value is 30
page
optional
integer
API page offset, default value is 30
order_by
optional
string
Order by (ie. desc or asc) Default is "desc"
sort_by
optional
string
Sort by (ie. created_at)
date_range_min
optional
string
Minimum creation datetime in iso format
date_range_max
optional
string
Maximum creation datetime in iso format
location_geopoint
optional
object
Filter by location's latitude and longitude (ie. {"lat":35.7516600, "lng":10.7110900})
location_distance
optional
integer
If location's latitude and longitude are present, you can set radius in filter query
summary_keywords
optional
array
Filter by keywords in summary
text_keywords
optional
array
Filter by keywords in text
skills
optional
array
Filter by skills
languages
optional
array
Filter by languages
tags_included
optional
array
Filter by tags to include
tags_excluded
optional
array
Filter by tags to exclude
ranges_float
optional
array
Filter by range floats
ranges_date
optional
array
Filter by range dates
Response
200: OK
Jobs successfully retrieved.
{
"code": 200,
"message": "Job searching results",
"meta": {
"page": 1,
"maxPage": 73,
"count": 1,
"total": 73
},
"data": {
"jobs": [
{
"id": 4706,
"key": "d224a0e830605ca7dddab20956624a1ca38d7e45",
"reference": "STO00002082",
"name": "ALTERNANT(E) MASTER ACHATS – SUPPLY CHAIN (F/H)",
"url": null,
"summary": null,
"sections": [...],
"location": {
"text": "France Île-de-France Bois-Colombes",
"lat": 48.913539999999998,
"lng": 2.2673299999999998,
"gmaps": null,
"fields": []
},
"skills": [],
"languages": [],
"tags": [...],
"ranges_float": [],
"ranges_date": [],
"updated_at": "2020-06-09T12:39:57+0000",
"created_at": "2020-04-07T17:39:52+0000"
}
]
}
}
401: Unauthorized
Invalid secret key.
{
"code": 401,
"message": "Unauthorized. Invalid secret key: xxxxx "
}
Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
client.job.searching.list(board_keys=["board_key1", "board_key2"],
name="data scientist", page=1, limit=10,
order_by="asc", sort_by="created_at",
text_keywords=["engineer", "python"],
tags_included=[[{"name": "active", "value": True}]],
location_distance=30,
location_geopoint={"lat":33.59662,"lng":-7.61889})
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: "Your API Key",
api_user: "Your API user email"
});
client.job.searching.list(["board_key1", "board_key2"], {
name: "data scientist",
page: 1,
limit: 10,
order_by: "asc",
sort_by: "created_at",
text_keywords: ["engineer", "python"],
tags_included: [[{name: "active", value: true}]],
location_distance: 30,
location_geopoint: {"lat":33.59662,"lng":-7.61889}
});