get https://api.hrflow.ai/v1/ratings
This endpoint allows you to retrieve the list of ratings.
Prerequisites
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 leavesource_keysempty.- To filter by a specific job, include the parameters
(board_key, job_key//job_reference)and leaveboard_keysempty.
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_keysand 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_keysand leave(board_key, job_key//job_reference)empty.