Recruiter
One candidate from your CRM, in full
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/candidates/$CANDIDATE_ID" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"id": "string",
"candidateId": "string",
"name": "string",
"oneLiner": "string",
"location": "string",
"linkedinUrl": "string",
"personalUrl": "string",
"githubUrl": "string",
"yearsOfExperience": 0,
"addedAt": "string",
"relationshipStatus": "string",
"tags": [
"string"
],
"note": "string",
"resume": {
"onFile": true
},
"preferences": {
"source": "string",
"updatedAt": "string",
"locations": [
"string"
],
"salaryMin": 0,
"salaryMax": 0,
"ote": 0,
"workplace": [
"string"
],
"roleTypes": [
"string"
],
"fundingRounds": [
"string"
],
"visa": [
"string"
],
"visaAuthorization": "string",
"excludedIndustries": [
"string"
],
"companySizes": [
"string"
]
},
"experiences": [
{
"title": "string",
"company": "string",
"startDate": "string",
"endDate": "string",
"isCurrent": true,
"location": "string",
"employmentType": "string",
"description": "string"
}
],
"education": [
{
"school": "string",
"degree": "string",
"startDate": "string",
"endDate": "string"
}
],
"applications": [
{
"roleId": "string",
"roleName": "string",
"companyName": "string",
"urls": {
"browse": "string",
"recruit": "string"
},
"status": "string",
"currentStage": "string",
"furthestStage": "string",
"submittedAt": "string"
}
]
}
Required scopes:
Rate limit:
candidates:read, submissions:readRate limit:
default tier, 120 requests per minute per keycandidateId is the candidateId from listRecruiterCandidates. A candidate that isn’t in your CRM, or that you’ve hidden or archived, returns 404.
applications lists your submissions of this candidate, newest first, with status WITHDRAWN for a withdrawn one.
The resume file isn’t returned. experiences and education carry its structured content.
Path parameters
string
required
The
candidateId of a listRecruiterCandidates row.
Constraints: min length 1.Response
string
required
string
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
string | null
required
number | null
required
string
required
string
required
string[]
required
string | null
required
Your own free-text CRM note on this candidate.
object
required
Whether the CRM row has a profile resume. The file itself isn’t returned;
experiences and education are its structured content.Show resume properties
Show resume properties
boolean
required
object | null
required
What the candidate wants: the newest preferences you or the candidate typed, else the newest inferred ones. Null when nothing is saved.
object[]
required
object[]
required
object[]
required
Your submissions of this candidate, newest first.
Show applications properties
Show applications properties
string
required
string
required
string
required
object
required
string
required
WITHDRAWN when the submission was withdrawn.string | null
required
string | null
required
string
required
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/candidates/$CANDIDATE_ID" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"id": "string",
"candidateId": "string",
"name": "string",
"oneLiner": "string",
"location": "string",
"linkedinUrl": "string",
"personalUrl": "string",
"githubUrl": "string",
"yearsOfExperience": 0,
"addedAt": "string",
"relationshipStatus": "string",
"tags": [
"string"
],
"note": "string",
"resume": {
"onFile": true
},
"preferences": {
"source": "string",
"updatedAt": "string",
"locations": [
"string"
],
"salaryMin": 0,
"salaryMax": 0,
"ote": 0,
"workplace": [
"string"
],
"roleTypes": [
"string"
],
"fundingRounds": [
"string"
],
"visa": [
"string"
],
"visaAuthorization": "string",
"excludedIndustries": [
"string"
],
"companySizes": [
"string"
]
},
"experiences": [
{
"title": "string",
"company": "string",
"startDate": "string",
"endDate": "string",
"isCurrent": true,
"location": "string",
"employmentType": "string",
"description": "string"
}
],
"education": [
{
"school": "string",
"degree": "string",
"startDate": "string",
"endDate": "string"
}
],
"applications": [
{
"roleId": "string",
"roleName": "string",
"companyName": "string",
"urls": {
"browse": "string",
"recruit": "string"
},
"status": "string",
"currentStage": "string",
"furthestStage": "string",
"submittedAt": "string"
}
]
}
⌘I
curl -X GET "https://external-api.paraform.com/api/external/v1/recruiter/candidates/$CANDIDATE_ID" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"id": "string",
"candidateId": "string",
"name": "string",
"oneLiner": "string",
"location": "string",
"linkedinUrl": "string",
"personalUrl": "string",
"githubUrl": "string",
"yearsOfExperience": 0,
"addedAt": "string",
"relationshipStatus": "string",
"tags": [
"string"
],
"note": "string",
"resume": {
"onFile": true
},
"preferences": {
"source": "string",
"updatedAt": "string",
"locations": [
"string"
],
"salaryMin": 0,
"salaryMax": 0,
"ote": 0,
"workplace": [
"string"
],
"roleTypes": [
"string"
],
"fundingRounds": [
"string"
],
"visa": [
"string"
],
"visaAuthorization": "string",
"excludedIndustries": [
"string"
],
"companySizes": [
"string"
]
},
"experiences": [
{
"title": "string",
"company": "string",
"startDate": "string",
"endDate": "string",
"isCurrent": true,
"location": "string",
"employmentType": "string",
"description": "string"
}
],
"education": [
{
"school": "string",
"degree": "string",
"startDate": "string",
"endDate": "string"
}
],
"applications": [
{
"roleId": "string",
"roleName": "string",
"companyName": "string",
"urls": {
"browse": "string",
"recruit": "string"
},
"status": "string",
"currentStage": "string",
"furthestStage": "string",
"submittedAt": "string"
}
]
}