⭐ Rate a Profile or a Job

post

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

This endpoint allows you to rate a Profile (resp. a Job) for Job (resp. a Profile) as a recruiter (resp. a candidate) with a score between 0 and 1.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Prerequisites

✨ Create a Workspace

🔑 Get your API Key

🔌 Create a Source

💾 Index a Profile in the Source

🔌 Create a Board

💾 Index a Job

Request headers

Field	Value
`X-API-KEY`	Your API Key.
`X-USER-EMAIL`	Your HrFlow.ai account's email.

🚧
Request Parameters
The job_key and the job_reference cannot be null at the same time in the Request Parameters. The same for the profile_key and profile_reference .

Body Params

score

float

required

The score is an evaluation fit between 0 to 1 . If you're using stars in your system please use the following conversion: 5 stars = 1.0 , 4 stars=0.8 , 3 stars=0.6, 2 stars=0.4, 1 star= 0.2 .

role

string

required

Role of the user rating the job (role: recruiter, candidate, employee, manager).

board_key

string

required

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.

source_key

string

required

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.

author_email

string

Email of the HrFlow.ai user who rated the profile for the job.

comment

string

Comment explaining the reason behind the score.

created_at

string

ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX — for example, "2000-10-31T01:30:00.000-05:00". It associates a creation date to the profile (ie: this can be for example the original date of the application of the profile). If not provided the creation date will be now by default.

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Prerequisites

Request headers

Request Parameters

200200