v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Applications

Listing applications

Returns a list of candidate applications. Click here for more information.

get/jobs/{jobId}/applications

Path parameters

jobIdinteger required

Job ID

Query parameters

idinteger

Application ID, queries passing this parameter will have higher request limit

status'in_process' | 'give_up' | 'reproved' | 'hired'

Current application status

currentStep.namestring

Current step name of the candidate application in the job (eg. Cadastro)

candidate.identificationDocumentstring

Candidate identification document (CPF or other) (eg. 99999999999)

vacancyCode.codestring

Vacancy code associated to the candidate (after hiring)

orderstring

Sorting order. The following fields are available: id, score, createdAt

fieldsstring

Specify fields to return (eg. fields=id,candidate.name or fields=all)
Default: id, score, createdAt, updatedAt, endedAt, tags, partnerName, job.id, job.name, currentStep.id, currentStep.name, candidate.id, candidate.name, candidate.lastName, candidate.email, candidate.birthdate, candidate.identificationDocument, candidate.linkedinProfileUrl, candidate.gender, candidate.mobileNumber, candidate.phoneNumber, manualCandidate.id, manualCandidate.name, manualCandidate.lastName, manualCandidate.email, manualCandidate.mobileNumber, manualCandidate.linkedinProfileUrl, manualCandidate.insertionSource, candidate.academicQualification.id, candidate.academicQualification.formation, candidate.academicQualification.institution, candidate.academicQualification.course, candidate.academicQualification.status, candidate.academicQualification.startMonth, candidate.academicQualification.startYear, candidate.academicQualification.endMonth, candidate.academicQualification.endYear

perPageinteger

Pagination: How many items per page

pageinteger

Pagination: Which page to query

Response

An array of candidates

totalResultsinteger
pageinteger
totalPagesinteger
All 161 operations