Recruiter
Your saved role preferences
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/preferences" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"roleTypes": [
"string"
],
"locations": [
"string"
],
"industries": [
"string"
],
"workplaceTypes": [
"string"
],
"fundingRounds": [
"string"
],
"minSalary": 0,
"description": "string"
}
Required scopes:
Rate limit:
roles:readRate limit:
default tier, 120 requests per minute per keylistRecruiterRoles applies when you pass matchMyPreferences.
An empty array means nothing is saved for that preference, so matchMyPreferences adds no filter for it; minSalary null means no salary preference is saved. minSalary is the saved annual salary preference as a whole number; no currency is stored with it. matchMyPreferences applies it to the role salary-band filter, so matched roles are ones whose salary band reaches it, not roles whose minimum meets it. description is the recruiter’s own free text, null when none was written.
These are stated preferences, not inferred ones. Paraform separately derives specialties from a recruiter’s placement history, and those are not returned here.
This endpoint is read-only. Preferences are edited in the Paraform app.
Response
string[]
required
string[]
required
string[]
required
string[]
required
string[]
required
number | null
required
string | null
required
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/preferences" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"roleTypes": [
"string"
],
"locations": [
"string"
],
"industries": [
"string"
],
"workplaceTypes": [
"string"
],
"fundingRounds": [
"string"
],
"minSalary": 0,
"description": "string"
}
⌘I
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/preferences" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"roleTypes": [
"string"
],
"locations": [
"string"
],
"industries": [
"string"
],
"workplaceTypes": [
"string"
],
"fundingRounds": [
"string"
],
"minSalary": 0,
"description": "string"
}