Recruiter
Your recommended submissions, across every candidate in your CRM
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/recommendations?limit=20" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"enabled": true,
"candidates": [
{
"candidateId": "string",
"name": "string",
"title": "string",
"linkedinUrl": "string",
"roles": [
{}
]
}
]
}
Required scopes:
Rate limit:
candidates:read, roles:readRate limit:
default tier, 120 requests per minute per keylistRecommendedRolesForCandidate instead. Never answer the whole-CRM question by looping that endpoint over every candidate: this call returns the same rows at once.
Pairs are ranked ENDORSED before SUGGESTED and by match strength inside each band. The list already leaves out candidates hired recently, roles the candidate was already submitted to, and roles you cannot submit to. Every role carries the full listRecruiterRoles shape, so you can rank by payout, competition and whether you hold the slot.
This read returns at most 20 (candidate, role) pairs, the strongest first. An empty list with enabled true means Paraform has no active recommendation for any of your candidates right now.
Query parameters
integer
default:"20"
Constraints: minimum 1.
Response
boolean
required
object[]
required
Show candidates properties
Show candidates properties
string
required
string
required
string | null
required
string | null
required
object[]
required
Show roles properties
Show roles properties
string
required
string
required
string | null
required
object
required
string[]
required
string | null
required
string[]
required
string[]
required
string | null
required
object
required
object
required
object
required
object
required
Show myRole properties
Show myRole properties
boolean
required
boolean
required
string | null
required
string | null
required
object
required
object
required
object
required
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/recommendations?limit=20" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"enabled": true,
"candidates": [
{
"candidateId": "string",
"name": "string",
"title": "string",
"linkedinUrl": "string",
"roles": [
{}
]
}
]
}
⌘I
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/recommendations?limit=20" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"enabled": true,
"candidates": [
{
"candidateId": "string",
"name": "string",
"title": "string",
"linkedinUrl": "string",
"roles": [
{}
]
}
]
}