Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Prospect Details

List prospect details

A prospect detail is the per-prospect record that captures where a candidate sits in the CRM: which prospect pool and stage they currently occupy, who owns them, and the department/office they are being considered for. Each prospect detail is attached to exactly one prospect application (an application that has not yet been moved onto a job); together with /v3/prospect_pools and /v3/prospect_pool_stages, these rows let an integration reconstruct the full state of a customer's CRM pipeline. department_id and office_id are derived from the application's prospective department record, not from the candidate or job, so they may differ from the offices and departments returned by other endpoints for the same application.

get/v3/prospect_details

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
application_idsinteger[]

Comma separated list

pool_idsinteger[]

Comma separated list

pool_stage_idsinteger[]

Return only prospect details whose current prospect pool stage matches one of these stage ids. Stage ids are unique across pools, so this can be used without also passing pool_ids.

prospect_owner_idsinteger[]

Return only prospect details owned by these Greenhouse user ids.

department_idsinteger[]

Return only prospect details whose underlying application is being considered for one of these department ids (matches the prospective department, not the application's hiring plan department).

office_idsinteger[]

Return only prospect details whose underlying application is being considered for one of these office ids (matches the prospective department's office, not the application's hiring plan office).

fieldsstring[]

Comma separated list of fields to return

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
application_idinteger

Id of the prospect application this record belongs to. Each prospect detail is attached to exactly one application; prospects are applications that have not yet been moved onto a job.

pool_idinteger nullable

Id of the prospect pool the prospect currently sits in (prospect_pools.id). null when the prospect has been added to the CRM without being placed in a pool yet.

pool_stage_idinteger nullable

Id of the prospect pool stage the prospect currently sits in (prospect_pool_stages.id). null when the prospect has no current stage; when set, it is always a stage that belongs to pool_id.

prospect_owner_idinteger nullable

Id of the Greenhouse user designated as the owner of this prospect. null when the prospect is unowned.

department_idinteger

Id of the department recorded on the prospect's prospective department (the department the prospect is being considered for), derived from the underlying application.

office_idinteger

Id of the office recorded on the prospect's prospective department (the office the prospect is being considered for), derived from the underlying application.