GRgreenhouse
Applications

Convert a prospect to a candidate

Promote a prospect application to a candidate application on a specific job. job_id is required and the prospect must already be associated with that job (or attached at the prospect pool level). Pass to_job_interview_stage_id to place the new candidate application on a specific interview stage; omit it to land them on the job's first stage. The prospect application's status transitions to converted and a new candidate application is returned in the response.

post/v3/applications/{id}/convert_to_candidate

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/applications/{id}/convert_to_candidate
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:applications:convert_to_candidate
    • or HTTP bearer

Path parameters

idinteger required

Request body

job_idinteger required
to_job_interview_stage_idinteger

Response

Successful (No Content)

idinteger
created_atstring date-time
updated_atstring date-time

Timestamp the application was last updated, in ISO 8601. Changes to candidate-level data (name, title, company, or last activity) also update it, so activity on one application usually moves this on all of the candidate's applications.

agency_note_idinteger nullable

Id of the note created when the candidate was submitted by an agency, or null if the application did not come through an agency.

candidate_idinteger

Id of the candidate (person) this application belongs to.

coordinator_idinteger nullable

Id of the user assigned as coordinator on the application's job, or null when unassigned.

job_idinteger nullable

Id of the job this application is on. null for jobless prospect applications.

job_post_idinteger nullable

Id of the job post the candidate applied through, or null if the application was created internally rather than from a posted role.

recruiter_idinteger nullable

Id of the user assigned as recruiter on the application's job, or null when unassigned.

referrer_idinteger nullable

Id of the referrer who credited this application, or null if there was no referral. References a referrer, not a Greenhouse user.

rejection_reason_idinteger nullable

Id of the rejection reason selected for the application. References a /v3/rejection_reasons row scoped to the organization. null when the application was rejected without a reason, or has not been rejected.

source_idinteger nullable

Id of the source the application is attributed to (e.g. a job board, an event, an employee referral source). null if no source is set.

stage_idinteger nullable

Id of the interview stage the candidate is currently in for this application. null for prospect applications and applications in a terminal state.

job_interview_stage_idinteger nullable

Id of the job interview stage definition (see GET /v3/job_interview_stages) the candidate is currently in for this application. null for prospect applications and applications in a terminal state.

stage_namestring nullable

Display name of the candidate's current interview stage on this application.

status'rejected' | 'hired' | 'converted' | 'in_process'

Lifecycle status of the application. in_process for active candidates, rejected for rejected applications, hired once an offer is closed and the hire endpoint has fired, and converted for prospect applications that have been promoted to a candidate application via convert_to_candidate.

needs_decisionboolean nullable

true when the application is waiting on a hiring-team decision (scorecard completion, advance/reject, etc.) in its current stage.

prospectboolean

true for prospect applications (sourced candidates not yet attached to a single job), false for candidate applications on a specific job.

rejected_atstring date-time nullable

Timestamp the application was rejected, in ISO 8601. null for applications that have not been rejected.

last_activity_atstring date-time nullable

Timestamp of recent activity for this application's candidate, in ISO 8601. Most activity (notes, emails, stage changes, etc.) on any of the candidate's applications updates this value on all of them, so it usually matches the candidate's last_activity_at rather than reflecting this application alone.

location_addressstring nullable

Free-form location string captured on the application (typically from the job post's location question).

prospective_job_idsinteger[]

For prospect applications, the ids of jobs the prospect is being considered for. Empty for non-prospect applications and for jobless prospects.

custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.