recruiter.listApplicants

List applicants in a project's talent pool (POST-as-list; the body carries filters, no state mutates).

Prerequisites

• A Curviate API key, passed as apiKey when you construct the client. Authentication and accounts shows how to create one.
• A connected LinkedIn account. This resource is account-scoped: the account_id is injected automatically by the account-scoped accessor, so you pass it once to curviate.account(...) and every call below inherits it. Authentication and accounts covers connecting one, and accounts.list returns the account_id of each account already connected.
• Requires the Recruiter add-on on the seat. Without it, calls return TIER_NOT_ACTIVE (403).

Signature

listApplicants(projectId: string, body: RecruiterListApplicantsBody, params?: Partial<RecruiterListApplicantsQuery>): Promise<RecruiterListApplicantsResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const page = await curviate.account("acc_YOUR_ACCOUNT_ID").recruiter.listApplicants("proj_YOUR_PROJECT_ID", { channel_id: "YOUR_CHANNEL_ID" });
for (const item of page.data ?? []) {
  console.log(item.id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).

Parameters

Returns

Resolves to RecruiterListApplicantsResult. Top-level fields: object, data, cursor, total_count.

Error codes

Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.

Next steps

• recruiter.searchParameters: resolve a human term into the opaque parameter ids the filters above take. Resolve first, then filter.
• recruiter.listJobs: List Recruiter job postings.
• recruiter.listPipeline: List candidates in a project's pipeline (POST-as-list; the body carries an all-optional filter set, no state mutates).
• SDK Quick Start: installation, the client, account scoping, and pagination.