---
updatedAt: 2026-05-22T13:54:10.000Z
agentTools:
projectIndex: https://developers.hrflow.ai/llms.txt
---
# ⭐ Get Ratings
This endpoint allows you to retrieve the list of ratings.
> 📘 Prerequisites
>
> 1. [✨ Create a Workspace](https://hrflow.ai/signup)
> 2. [🔑 Get your API Key](https://developers.hrflow.ai/docs/api-authentification)
> 3. [⭐ Rate Profiles for a Job](https://developers.hrflow.ai/reference/post-rating)
## Request headers
| Field | Value |
| :------------------------ | :------------------------------- |
| X-API-KEY | Your API Key. |
| X-USER-EMAIL | Your HrFlow\.ai account's email. |
> 🚧 Retrieve Ratings Associated with a Specific Profile or Job
>
> * To filter by a specific profile, include the parameters (source\_key, profile\_key//profile\_reference) and leave source\_keys empty.
> * To filter by a specific job, include the parameters (board\_key, job\_key//job\_reference) and leave board\_keys empty.
> 🚧 Retrieve Ratings Associated with a Specific List of Profiles or Jobs
>
> * To filter ratings based on a list of profiles within a list of sources, include the parameter source\_keys and leave (source\_key, profile\_key//profile\_reference) empty.
> * To filter ratings based on a list of jobs within a list of boards, include the parameter board\_keys and leave (board\_key, job\_key//job\_reference) empty.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "website-api",
"version": "2.3"
},
"servers": [
{
"url": "https://api.hrflow.ai/v1"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "header",
"name": "X-API-KEY",
"x-default": ""
},
"sec1": {
"type": "apiKey",
"in": "header",
"name": "X-USER-EMAIL"
}
}
},
"security": [
{
"sec0": [],
"sec1": []
}
],
"paths": {
"/ratings": {
"get": {
"summary": "⭐ Get Ratings",
"description": "This endpoint allows you to retrieve the list of ratings.",
"operationId": "get-ratings",
"parameters": [
{
"name": "role",
"in": "query",
"description": "Role of the user rating the profile or the job.",
"required": true,
"schema": {
"type": "string",
"enum": [
"recruiter",
"candidate",
"employee",
"manager"
]
}
},
{
"name": "source_keys",
"in": "query",
"description": "The list of the keys of the Sources containing the targeted Profiles. Example : `[\"xxx\", \"yyy\", \"zzz\"]`",
"schema": {
"type": "string"
}
},
{
"name": "source_key",
"in": "query",
"description": "The key of Source attached to the given Job.",
"schema": {
"type": "string"
}
},
{
"name": "profile_key",
"in": "query",
"description": "The Profile's unique identifier.",
"schema": {
"type": "string"
}
},
{
"name": "profile_reference",
"in": "query",
"description": "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.",
"schema": {
"type": "string"
}
},
{
"name": "board_keys",
"in": "query",
"description": "The list of the keys of the Boards containing the targeted Jobs. Example : `[\"xxx\", \"yyy\", \"zzz\"]`",
"schema": {
"type": "string"
}
},
{
"name": "board_key",
"in": "query",
"description": "The key of Board attached to the given Job.",
"schema": {
"type": "string"
}
},
{
"name": "job_key",
"in": "query",
"description": "The Job's unique identifier.",
"schema": {
"type": "string"
}
},
{
"name": "job_reference",
"in": "query",
"description": "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.",
"schema": {
"type": "string"
}
},
{
"name": "return_profile",
"in": "query",
"description": "Set to True to return the full profile JSON of each rated profile in the array response.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "return_author",
"in": "query",
"description": "Set to True to return the full JSON of the author of each rating in the array response.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "page",
"in": "query",
"description": "The number of the current results' page.",
"schema": {
"type": "string",
"default": "1"
}
},
{
"name": "limit",
"in": "query",
"description": "The number of results per page",
"schema": {
"type": "string",
"default": "30"
}
},
{
"name": "order_by",
"in": "query",
"description": "Order results by asc, or desc.",
"schema": {
"type": "string",
"default": "desc"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sort results by scoring or created_at",
"schema": {
"type": "string",
"default": "scoring"
}
},
{
"name": "created_at_min",
"in": "query",
"description": "Set a minimum creation date.",
"schema": {
"type": "string"
}
},
{
"name": "created_at_max",
"in": "query",
"description": "Set a maximum creation date.",
"schema": {
"type": "string"
}
},
{
"name": "location_lat",
"in": "query",
"description": "Desired geopoint latitude of the profiles.",
"schema": {
"type": "number",
"format": "float"
}
},
{
"name": "location_lon",
"in": "query",
"description": "Desired geopoint longitude of the profiles.",
"schema": {
"type": "number",
"format": "float"
}
},
{
"name": "location_distance",
"in": "query",
"description": "Set a radius around the Profiles' location address (in Km).",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "use_location_address",
"in": "query",
"description": "Filter Profiles by their address' geolocation.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "use_location_experience",
"in": "query",
"description": "Filter Profiles by their experiences' geolocation.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "use_location_education",
"in": "query",
"description": "Filter Profiles by their educations' geolocations.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "experiences_duration_min",
"in": "query",
"description": "Set a minimum number of years of experience.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "experiences_duration_max",
"in": "query",
"description": "Set a maximum number of years of experience.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "educations_duration_min",
"in": "query",
"description": "Set a minimum number of years of education.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "educations_duration_max",
"in": "query",
"description": "Set a maximum number of years of education.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": ""
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Could not find a source matching this query": {
"value": "{\n \"code\": 400,\n \"message\": \"Bad Request. Invalid source ids\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 400,
"default": 0
},
"message": {
"type": "string",
"example": "Bad Request. Invalid source ids"
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Invalid secret key": {
"value": "{\n \"code\": 401,\n \"message\": \"Unauthorized. Invalid secret key: xxxxx \"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 401,
"default": 0
},
"message": {
"type": "string",
"example": "Unauthorized. Invalid secret key: xxxxx "
}
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```