⭐ [New] Get Trackings

get

https://api.hrflow.ai/v1/trackings

This endpoint allows you to retrieve the list of trackings.

Query Params

actions

string

The list of actions. Example : `["xxx", "yyy", "zzz"]. The 'action' refers to a unique identifier for a profile or job stage. This can be a specific stage ID within a CRM, ATS, or Job site. Examples of such stages include "view," "apply," "hire," or any other stage relevant to your system.

role

string

enum

required

Role of the user tracking the profile or the job.

Allowed:

source_keys

string

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

source_key

string

The key of Source attached to the given Profile.

profile_key

string

The Profile's unique identifier.

profile_reference

string

The Profile reference chosen by the customer or an external system. If you use the profile_key you do not need to specify the profile_reference and vice versa.

board_keys

string

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

board_key

string

The key of Board attached to the given Job.

job_key

string

The Job's unique identifier.

job_reference

string

The Job reference chosen by the customer or an external system. If you use the job_key you do not need to specify the job_reference and vice versa.

return_profile

boolean

Defaults to false

Set to True to return the full profile JSON of each rated profile in the array response.

return_author

boolean

Defaults to false

Set to True to return the full JSON of the author of each rating in the array response.

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

Defaults to desc

Order results by asc, or desc.

sort_by

string

Defaults to scoring

Sort results by scoring or created_at

created_at_min

string

Set a minimum creation date.

created_at_max

string

Set a maximum creation date.

location_lat

float

Desired geopoint latitude of the profiles.

location_lon

float

Desired geopoint longitude of the profiles.

location_distance

int32

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

use_location_address

boolean

Defaults to false

Filter Profiles by their address' geolocation.

use_location_experience

boolean

Defaults to false

Filter Profiles by their experiences' geolocation.

use_location_education

boolean

Defaults to false

Filter Profiles by their educations' geolocations.

experiences_duration_min

int32

Set a minimum number of years of experience.

experiences_duration_max

int32

Set a maximum number of years of experience.

educations_duration_min

int32

Set a minimum number of years of education.

educations_duration_max

int32

Set a maximum number of years of education.

Responses

200200

400400

401401