🧠 Score Profiles indexed in Sources for a Job

get

https://api.hrflow.ai/v1/profiles/scoring

This endpoint allows you to Score Profiles for Job.

Query Params

algorithm_key

string

required

The key of the Scoring Algorithm.

use_algorithm

string

Defaults to 1

Turn 0 to switch the Scoring to the Searching only mode.

job_key

string

The Job's unique identifier.

job_reference

string

The Job reference chosen by the customer.

board_key

string

required

The key of Board attached to the given Job.

source_keys

string

required

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

exclude_profile_keys

string

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

stage

string

enum

Filter Profiles by their stage: new, yes , later, no. If not provided the results will includes all stage values.

Allowed:

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.

name

string

Filter Profiles by their name.

string

Filter Profiles by their email.

location_geopoint

object

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

location_distance

int32

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

summary_keywords

string

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

text_keywords

string

Filter Profiles 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.

experience_keywords

string

Filter Profiles by keywords in their experiences' titles and descriptions. Example : ["xxx", "yyy", "zzz"]

experience_location_geopoint

string

Filter Profiles by their experiences' locations. Example : {"lat":47.21812, "lon":-1.55306}

experience_location_distance

int32

Set a radius around the educations' locations (in Km)

experiences_duration_min

int32

Set a minimum number of years of experience.

experiences_duration_max

int32

Set a maximum number of years of experience.

education_keywords

string

Filter Profiles by keywords in their educations' titles and descriptions. Example : ["xxx", "yyy", "zzz"]

education_location_geopoint

string

Filter Profiles by their educations locations. Example : {"lat":47.21812, "lon":-1.55306}

education_location_distance

int32

Set a radius around the educations' locations (in Km).

educations_duration_min

int32

Set a minimum number of years of education.

educations_duration_max

int32

Set a maximum number of years of education.

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}]

interests

string

Filter results by a list of interest names and their values. Example : [{"name":"sport", "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"}]]

Responses

200200

400400