Jobs Searching

What do you need ? How to do it ? And where to display it ?

What do you need to use Jobs Searching ?

📘

Prerequisites

  1. ✨ Create a Workspace
  2. 🔑 Get your API Key
  3. 🧠 Activate Profiles Searching API
  4. 🔌 Create a Source
  5. 💾 Index Profiles in the Source

1 - Activate Jobs Searching

Make sure that the Jobs Searching feature is in your account plans features to be able feature to search indexed Jobs.
If it's not the case, please reach out to us.

2 - Index the Jobs in HrFlow.ai

In order to use the Jobs Searching feature, you will need first to have all your jobs indexed in HrFlow.ai.
Jobs in HrFlow.ai are indexed in special folders called Boards. If you don't have a Board created yet, you can refer to this page Create, Configure a Board to create and configure your Board.
If you are dealing with data coming from multiple origins, creating multiple Boards is the best way to organize the data in HrFlow.ai.

In this example, we would like to separate Jobs to be published in our Career Site and others to be published on LinkedIn, therefore, for this purpose we created two Boards, where jobs from both sources can be separately indexed, and later on searched.

Connections > My Boards (jobs)Connections > My Boards (jobs)

Connections > My Boards (jobs)

To index the Jobs in HrFlow.ai, you can refer to 💾 Index a Job in a Board or directly try the corresponding endpoint in our Postman collection.

Run in PostmanRun in Postman

Don't hesitate to check our publication on Using Postman with Hrflow.ai API to help you get started quickly with our Postman collection.

🚧

Index Job with a reference

To simplify Job updating in HrFlow.ai, consider specifying a reference when indexing it.
The reference you use when invoking the endpoint 💾 Index a Job in a Board will identify the Job in HrFlow.ai (along with the Job key).

The reference is not mandatory, if it is not provided, however the Job will have a unique identification key generated by HrFlow.ai during the indexing.

3 - Add Custom Attributes

You can add custom attributes to further adapt the Job to your business needs.

  • Tags : are custom attributes uniquely identified by name and value, where the name is the name of the new field to add, and the value is its value.
  • Float Ranges
  • Data Ranges

Here is an example that shows how to add two additional custom fields contract_type and entity as tags in the HrFlow.ai Job object.

{..., 
  "tags": [{"name": "contract_type", "value": "Full Time"},
          {"name": "entity", "value": "R&D"}], ...}

4 - Update indexed Jobs in HrFlow.ai

To ensure that the data indexed in HrFlow.ai and which will be searched is always the latest updated version of the data, it is necessary to update all Jobs on which changes have taken place using their reference and the corresponding Board key.
Check here for more details on how to 💾 Edit a Job indexed in a Board.

How to filter Jobs with multi-criteria queries ?

Once the Jobs are indexed in the corresponding Boards, we can then use the HrFlow.ai Searching API to make a multi-criteria query search. This search query can be applied to Jobs in one or multiple Boards.

Please refer to 🧠 Search Jobs indexed in Boards, to see the query structure and all the different criteria that can be used to filter the Jobs in the selected Boards.

Pagination enables you to have full control over the way you retrieve query results.
You can fetch a specific page by using the page parameter which serves as a page offset combined with the limit parameter that specifies the number of profiles per page.

📘

Retrieving query results

It is recommended not to use large values for the limit parameter and instead rely on the pagination to retrieve all the query results.

You can try the 🧠 Search Jobs indexed in Boards endpoint directly in our Postman collection, to get a sense of what kind of data they'll return.

Run in PostmanRun in Postman

Don't hesitate to check our publication on Using Postman with Hrflow.ai API to help you get started quickly with our Postman collection.

How to display Jobs Searching results ?

The overall setup can be integrated in one place where multi-criteria filters can be set by the user and the Jobs Searching endpoint is called with the underlying query and the returned results are then displayed in a more user-friendly format.

Here is an example using Plain HTML, Plain CSS and Vanilla Javascript to retrieve Jobs from our Searching API and display results on a page.


Did this page help you?