🧠 Match Jobs indexed in Boards to a Job

get

https://api.hrflow.ai/v1/jobs/matching

This endpoint allows you to find Jobs similar to a target Job.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

job_key

string

The Job's unique identifier.

exclude_job_keys

string

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

job_reference

string

The Job reference chosen by the customer.

board_key

string

required

The key of Board attached to the Job.

board_keys

string

required

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

page

string

Defaults to 1

The number of the current results' page.

limit

string

Defaults to 30

The number of results per page

order_by

string

enum

Defaults to desc

Order results by asc, or desc.

Allowed:

sort_by

string

enum

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

Allowed:

created_at_min

string

Set a minimum creation date.

created_at_max

string

Set a maximum creation date.

names

string

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

location_geopoint

string

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

location_distance

int32

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

summary_keywords

string

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

text_keywords

string

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

enrich_text_keywords

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.

skills

string

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

languages

string

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

tags_included

string

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

tags_excluded

string

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

ranges_float

string

Filter results by a range of floats. Example : [{"name":"salary", "value_min":30, "value_max":40}]

ranges_date

string

Filter results by a range of dates. Example : [{"name":"Dates", "value_min":"2020-05-18T21:59", "value_max":"2020-09-15T21:59"}]

Responses

200200

400400

401401