Recruiter
Everything you can see about one role
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/roles/$ROLE_ID" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"summary": {
"id": "string",
"name": "string",
"postedAt": "string",
"urls": {
"browse": "string",
"recruit": "string"
},
"company": {
"name": "string",
"confidentialSearch": true,
"anonymizedName": "string",
"oneLiner": "string",
"industries": [
"string"
],
"size": 0
},
"locations": [
"string"
],
"workplaceType": "string",
"roleTypes": [
"string"
],
"techStack": [
"string"
],
"visaText": "string",
"compensation": {
"salaryLowerBound": 0,
"salaryUpperBound": 0,
"currency": "string",
"equity": "string"
},
"experience": {
"yearsMin": 0,
"yearsMax": 0
},
"fee": {
"amountLowerBound": 0,
"percentOfSalary": 0,
"boostPercent": 0,
"bonusAmount": 0,
"firstSubmissionReward": 0
},
"pipeline": {
"totalApplications": 0,
"totalInterviewing": 0,
"totalHired": 0,
"openingsText": "string"
},
"myRole": {
"isApproved": true,
"isPrimary": true,
"accessLevel": "string",
"approvalStatus": "string",
"submissions": {
"submitted": 0,
"interviewing": 0,
"hired": 0,
"total": 0
},
"trial": {
"endsAt": "string",
"businessDaysLeft": 0,
"submissionGoal": 0,
"submissionsCounted": 0,
"isActive": true,
"endingSoon": true
}
},
"recruiterAccess": {
"atMaxCapacity": true,
"notAcceptingRecruiters": true,
"density": "string"
},
"hiringManager": {
"lastActiveAt": "string",
"responsivenessDays": 0,
"engagement": {
"finalRating": 0,
"percentileRank": 0
}
}
},
"about": {
"description": "string",
"responsibilities": [
"string"
],
"experience": "string",
"positionExplanation": "string",
"hiringGoals": "string",
"salaryDetail": "string"
},
"requirements": [
{
"description": "string",
"explanation": "string",
"type": "string"
}
],
"candidateTraits": [
"string"
],
"avoidTraits": [
"string"
],
"hiringManagerQuestions": [
{
"question": "string",
"explanation": "string",
"optional": true,
"recruiterOnly": true,
"priority": "string"
}
],
"interviewProcess": [
{
"name": "string",
"description": "string"
}
],
"pitch": {
"sellingPoints": [
{
"title": "string",
"description": "string"
}
],
"recruitingAdvice": "string",
"hiringManagerTip": "string",
"outreachGuidelines": "string",
"outreachHighlights": [
"string"
],
"outreachResponsibilities": "string",
"recruiterSellingPoints": "string",
"candidateSellingPoints": "string",
"outreachTemplates": [
{
"name": "string",
"subject": "string",
"body": "string"
}
],
"targetCompanies": {
"description": "string",
"goodFitCategories": [
"string"
]
},
"avoidCompanies": {
"badFitCategories": [
"string"
]
},
"calibrationProfiles": [
{
"label": "string",
"note": "string"
}
],
"faqs": [
{
"question": "string",
"answer": "string"
}
],
"announcements": [
{
"message": "string",
"createdAt": "string"
}
]
},
"company": {
"name": "string",
"confidentialSearch": true,
"anonymizedName": "string",
"description": "string",
"teamAbout": "string",
"websiteUrl": "string",
"foundingYear": 0,
"fundingAmount": "string",
"totalFundingAmount": "string",
"lastFundingRound": "string",
"benefits": [
"string"
],
"cultureValues": [
"string"
]
},
"pipeline": {
"stageCounts": [
{
"stage": "string",
"count": 0
}
],
"mySubmissions": [
{
"candidateName": "string",
"currentStatus": "string",
"furthestStageReached": "string",
"rejectionReason": "string",
"statusUpdateMessage": "string"
}
],
"rejectionPatterns": [
{
"category": "string",
"furthestStage": "string",
"reason": "string"
}
]
}
}
Required scopes:
Rate limit:
roles:readRate limit:
default tier, 120 requests per minute per keysummary repeats the listRecruiterRoles row so fee, competition, hiring manager engagement and your slot status are here too.
Outreach material is in pitch.outreachGuidelines and pitch.outreachHighlights (the hiring manager’s own guidance, when set), pitch.candidateSellingPoints, pitch.sellingPoints, pitch.recruitingAdvice, pitch.outreachTemplates and company. Screening material is in hiringManagerQuestions, requirements and interviewProcess, and submission context in requirements, pipeline.rejectionPatterns and pitch.calibrationProfiles.
When company.confidentialSearch is true the search is confidential: candidate-facing copy must refer to the employer as company.anonymizedName and must not name the company or quote copy that identifies it.
pipeline.mySubmissions is capped at the 30 newest and, for an agency owner, includes the agency’s submissions, so its length is not a total. summary.myRole.submissions counts only your own applications, so it is not an agency total either.
roleId is the id from listRecruiterRoles. A role you cannot work on returns 404.
Path parameters
string
required
Constraints: min length 1.
Response
object
required
Show summary properties
Show summary 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
string[]
required
string[]
required
object[]
required
object
required
Show pitch properties
Show pitch properties
string | null
required
string | null
required
string | null
required
string[]
required
string | null
required
string | null
required
string | null
required
object[]
required
object
required
object
required
Show pipeline properties
Show pipeline properties
object[]
required
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/roles/$ROLE_ID" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"summary": {
"id": "string",
"name": "string",
"postedAt": "string",
"urls": {
"browse": "string",
"recruit": "string"
},
"company": {
"name": "string",
"confidentialSearch": true,
"anonymizedName": "string",
"oneLiner": "string",
"industries": [
"string"
],
"size": 0
},
"locations": [
"string"
],
"workplaceType": "string",
"roleTypes": [
"string"
],
"techStack": [
"string"
],
"visaText": "string",
"compensation": {
"salaryLowerBound": 0,
"salaryUpperBound": 0,
"currency": "string",
"equity": "string"
},
"experience": {
"yearsMin": 0,
"yearsMax": 0
},
"fee": {
"amountLowerBound": 0,
"percentOfSalary": 0,
"boostPercent": 0,
"bonusAmount": 0,
"firstSubmissionReward": 0
},
"pipeline": {
"totalApplications": 0,
"totalInterviewing": 0,
"totalHired": 0,
"openingsText": "string"
},
"myRole": {
"isApproved": true,
"isPrimary": true,
"accessLevel": "string",
"approvalStatus": "string",
"submissions": {
"submitted": 0,
"interviewing": 0,
"hired": 0,
"total": 0
},
"trial": {
"endsAt": "string",
"businessDaysLeft": 0,
"submissionGoal": 0,
"submissionsCounted": 0,
"isActive": true,
"endingSoon": true
}
},
"recruiterAccess": {
"atMaxCapacity": true,
"notAcceptingRecruiters": true,
"density": "string"
},
"hiringManager": {
"lastActiveAt": "string",
"responsivenessDays": 0,
"engagement": {
"finalRating": 0,
"percentileRank": 0
}
}
},
"about": {
"description": "string",
"responsibilities": [
"string"
],
"experience": "string",
"positionExplanation": "string",
"hiringGoals": "string",
"salaryDetail": "string"
},
"requirements": [
{
"description": "string",
"explanation": "string",
"type": "string"
}
],
"candidateTraits": [
"string"
],
"avoidTraits": [
"string"
],
"hiringManagerQuestions": [
{
"question": "string",
"explanation": "string",
"optional": true,
"recruiterOnly": true,
"priority": "string"
}
],
"interviewProcess": [
{
"name": "string",
"description": "string"
}
],
"pitch": {
"sellingPoints": [
{
"title": "string",
"description": "string"
}
],
"recruitingAdvice": "string",
"hiringManagerTip": "string",
"outreachGuidelines": "string",
"outreachHighlights": [
"string"
],
"outreachResponsibilities": "string",
"recruiterSellingPoints": "string",
"candidateSellingPoints": "string",
"outreachTemplates": [
{
"name": "string",
"subject": "string",
"body": "string"
}
],
"targetCompanies": {
"description": "string",
"goodFitCategories": [
"string"
]
},
"avoidCompanies": {
"badFitCategories": [
"string"
]
},
"calibrationProfiles": [
{
"label": "string",
"note": "string"
}
],
"faqs": [
{
"question": "string",
"answer": "string"
}
],
"announcements": [
{
"message": "string",
"createdAt": "string"
}
]
},
"company": {
"name": "string",
"confidentialSearch": true,
"anonymizedName": "string",
"description": "string",
"teamAbout": "string",
"websiteUrl": "string",
"foundingYear": 0,
"fundingAmount": "string",
"totalFundingAmount": "string",
"lastFundingRound": "string",
"benefits": [
"string"
],
"cultureValues": [
"string"
]
},
"pipeline": {
"stageCounts": [
{
"stage": "string",
"count": 0
}
],
"mySubmissions": [
{
"candidateName": "string",
"currentStatus": "string",
"furthestStageReached": "string",
"rejectionReason": "string",
"statusUpdateMessage": "string"
}
],
"rejectionPatterns": [
{
"category": "string",
"furthestStage": "string",
"reason": "string"
}
]
}
}
⌘I
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/roles/$ROLE_ID" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"summary": {
"id": "string",
"name": "string",
"postedAt": "string",
"urls": {
"browse": "string",
"recruit": "string"
},
"company": {
"name": "string",
"confidentialSearch": true,
"anonymizedName": "string",
"oneLiner": "string",
"industries": [
"string"
],
"size": 0
},
"locations": [
"string"
],
"workplaceType": "string",
"roleTypes": [
"string"
],
"techStack": [
"string"
],
"visaText": "string",
"compensation": {
"salaryLowerBound": 0,
"salaryUpperBound": 0,
"currency": "string",
"equity": "string"
},
"experience": {
"yearsMin": 0,
"yearsMax": 0
},
"fee": {
"amountLowerBound": 0,
"percentOfSalary": 0,
"boostPercent": 0,
"bonusAmount": 0,
"firstSubmissionReward": 0
},
"pipeline": {
"totalApplications": 0,
"totalInterviewing": 0,
"totalHired": 0,
"openingsText": "string"
},
"myRole": {
"isApproved": true,
"isPrimary": true,
"accessLevel": "string",
"approvalStatus": "string",
"submissions": {
"submitted": 0,
"interviewing": 0,
"hired": 0,
"total": 0
},
"trial": {
"endsAt": "string",
"businessDaysLeft": 0,
"submissionGoal": 0,
"submissionsCounted": 0,
"isActive": true,
"endingSoon": true
}
},
"recruiterAccess": {
"atMaxCapacity": true,
"notAcceptingRecruiters": true,
"density": "string"
},
"hiringManager": {
"lastActiveAt": "string",
"responsivenessDays": 0,
"engagement": {
"finalRating": 0,
"percentileRank": 0
}
}
},
"about": {
"description": "string",
"responsibilities": [
"string"
],
"experience": "string",
"positionExplanation": "string",
"hiringGoals": "string",
"salaryDetail": "string"
},
"requirements": [
{
"description": "string",
"explanation": "string",
"type": "string"
}
],
"candidateTraits": [
"string"
],
"avoidTraits": [
"string"
],
"hiringManagerQuestions": [
{
"question": "string",
"explanation": "string",
"optional": true,
"recruiterOnly": true,
"priority": "string"
}
],
"interviewProcess": [
{
"name": "string",
"description": "string"
}
],
"pitch": {
"sellingPoints": [
{
"title": "string",
"description": "string"
}
],
"recruitingAdvice": "string",
"hiringManagerTip": "string",
"outreachGuidelines": "string",
"outreachHighlights": [
"string"
],
"outreachResponsibilities": "string",
"recruiterSellingPoints": "string",
"candidateSellingPoints": "string",
"outreachTemplates": [
{
"name": "string",
"subject": "string",
"body": "string"
}
],
"targetCompanies": {
"description": "string",
"goodFitCategories": [
"string"
]
},
"avoidCompanies": {
"badFitCategories": [
"string"
]
},
"calibrationProfiles": [
{
"label": "string",
"note": "string"
}
],
"faqs": [
{
"question": "string",
"answer": "string"
}
],
"announcements": [
{
"message": "string",
"createdAt": "string"
}
]
},
"company": {
"name": "string",
"confidentialSearch": true,
"anonymizedName": "string",
"description": "string",
"teamAbout": "string",
"websiteUrl": "string",
"foundingYear": 0,
"fundingAmount": "string",
"totalFundingAmount": "string",
"lastFundingRound": "string",
"benefits": [
"string"
],
"cultureValues": [
"string"
]
},
"pipeline": {
"stageCounts": [
{
"stage": "string",
"count": 0
}
],
"mySubmissions": [
{
"candidateName": "string",
"currentStatus": "string",
"furthestStageReached": "string",
"rejectionReason": "string",
"statusUpdateMessage": "string"
}
],
"rejectionPatterns": [
{
"category": "string",
"furthestStage": "string",
"reason": "string"
}
]
}
}