GET: /job/indexing

This endpoint allows you to retrieve an existing Job.

get
Get Job

https://api.hrflow.ai/v1/job/indexing
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token.
X-USER-EMAIL
required
string
User's email.
Query Parameters
board_key
required
string
Board key
key
required
string
Job' s key
reference
optional
string
Job's reference
Response
200: OK
Job successfully retrieved
{
"code": 200,
"message": "Job details",
"data": {
"id": id,
"key": "job_key",
"reference": "REF1",
"name": "Technicien de maintenance H/F",
"url": null,
"summary": null,
"sections": [
{
"name": "section's name",
"title": "section's title",
"description": "Section's description",
],
"location": {
"text": "France Auvergne-Rhône-Alpes Alby-sur-Chéran",
"lat": 45.817700000000002,
"lng": 6.0221499999999999,
"gmaps": null,
"fields": []
},
"skills": [],
"languages": [],
"tags": [
{
"name": "company",
"value": "alpha"
},
{
"name": "responsibility",
"value": "admin"
},
{
"name": "category",
"value": "Maintenance"
},
{
"name": "type",
"value": "CDI"
},
{
"name": "education_level",
"value": "Bac+5"
},
{
"name": "professional_experience",
"value": "Junior"
}
],
"ranges_float": [],
"ranges_date": [],
"updated_at": "2020-06-09T12:34:58+0000",
"created_at": "2020-04-06T12:02:31+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.indexing.get(board_key="board_key",
key="job_key",
# OR
reference='job_reference')
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: "Your API Key",
api_user: "Your API user email"
});
client.job.indexing.get("board_key", {
key: "job_key",
// Or
reference: "job_reference"
});