GuidesAPI EndpointsAPI Changelog
Live AI Demo
API Endpoints

💾 Get a Job indexed in a Board

This endpoint allows retrieving the Job object.

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

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🔌 Create a Board
  4. 💾 Index a Job

Request headers

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

Query Parameters

The key and the reference can not be null at the same time in the Query Parameters.

Query Params
string
required

The key of the Board associated to the job.

string

The Job unique identifier

string

The Job reference chosen by the customer.

Responses

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