Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Prospect Pools

List prospect pools

A prospect pool is an organization-defined collection of prospects (candidates not yet attached to a specific job), typically used to manage talent communities and sourcing pipelines. Each pool has its own ordered set of stages (see /v3/prospect_pools/{prospect_pool_id}/stages) that prospects move through, distinct from a job's interview plan. Pools may be restricted to specific departments, offices, or jobs (hiring plans) via department_ids, office_ids, and job_ids; when all three are empty, the pool is available organization-wide.

get/v3/prospect_pools

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
department_idsinteger[]

Comma separated list

office_idsinteger[]

Comma separated list

job_idsinteger[]

Return only prospect pools restricted to these job (hiring plan) ids.

fieldsstring[]

Comma separated list of fields to return

activeboolean

Filter by pool status. true returns active pools, false returns inactive (retained) pools.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
namestring

Name of the prospect pool, unique within the organization (case-insensitive).

activeboolean

Whether the pool is currently in use. Inactive pools are hidden from CRM workflows but are retained so existing prospects remain queryable.

descriptionstring nullable

Free-text purpose statement set by the organization (max 500 characters). null when no description has been set.

department_idsinteger[]

Ids of departments this pool is restricted to. Empty when the pool is not restricted by department; combined with office_ids and job_ids, an empty array on all three means the pool is unrestricted (available org-wide).

office_idsinteger[]

Ids of offices this pool is restricted to. Empty when the pool is not restricted by office.

job_idsinteger[]

Ids of jobs this pool is restricted to. Empty when the pool is not restricted by job.