List talent profiles

Return a list of talent profiles.

A talent profile represents a person in Pool's talent database. It is distinct from a Hire application or a WX worker profile.

Returns visible talent only by default (isHidden is not true and archivedAt does not exist). Pass onlyReturnHiddenTalent=true to return only hidden talent instead, or includeHidden=true to return BOTH visible and hidden talent (archived still excluded). Results are paginated: filter[limit] defaults to 100 when omitted and is capped at 1000; use filter[skip] to page through the full set. filter[collate] is accepted but NOT applied on this endpoint: a locale collation disqualifies every index on the collection, so matching and ordering are binary. String sorts therefore order by byte value — uppercase before lowercase, accented characters after the unaccented ASCII range. filter[order] takes ONE column, written '

ASC' or '
DESC' (the direction is required): createdAt, displayFullName, lastActivityAt, homeAddress.city, homeAddress.state, homeAddress.zip, aggregatedCampaignCalculatedStats.clickRate, aggregatedCampaignCalculatedStats.openRate, statsLastInteraction, talentType, mobilePhone.number, hireApplicants.createdAt, wxWorkers.employmentStatus.type, wxWorkers.employmentStatus.subtype; a custom attribute column (primaryCustomValues.calculatedCustomAttributes.); score, with vectors; or, with audienceCampaignUuid, that campaign's audienceCampaignStats.

To select matching records, see WX filtering and pagination. Only use the options listed in this endpoint's query parameters.

Query Params
filter
object
vectors
object | null
proximity
object | null
uuid
boolean

When true, returns only hidden talent (isHidden: true). Defaults to false, which returns only visible, non-archived talent.

boolean

When true, returns both visible AND hidden talent (archived still excluded). Ignored when onlyReturnHiddenTalent=true.

uuid

Restrict results to talents in this audience. With includeHidden=true, membership is resolved from talentAudienceHistory so hidden talents that lost their audienceUuids still appear.

Free-text search across talent name, email and phone. When set and no job-match vector/proximity is requested, results are served by an Atlas Search index; with a vector present the term narrows the matched candidates. Bounded to 200 characters.

string
enum

The Unread messages condition: only talent with unread SMS replies. Ignored while two-way SMS is off for the company; 403 for a role without the campaign conversation read action.

Allowed:
string
enum

Which of the campaign's recipients to list; needs audienceCampaignUuid (400 without it). all lists everyone enrolled, hidden included; receiving those the campaign can still message; excluded those it cannot (a terminal exit or a hidden profile). Absent, the list keeps its default shape: enrolled and visible. Every row of a campaign-scoped list carries audienceCampaignEnrollment. With excluded, filter[order] also accepts audienceCampaignEnrollment.exitedAt ASC|DESC (undated rows last).

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json