recruiter.listApplicants

Requires the Recruiter add-on. Calls return TIER_NOT_ACTIVE (403) when the seat does not have this add-on active.

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

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 result = await curviate.account("acc_YOUR_ACCOUNT_ID").recruiter.listApplicants("proj_YOUR_PROJECT_ID", { channel_id: "YOUR_CHANNEL_ID" });
console.log(`ListApplicants: ${result.cursor}`);

Parameters

Returns

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

Error codes

• UNAUTHORIZED
• INVALID_REQUEST
• RATE_LIMIT_ACCOUNT
• RATE_LIMIT_TENANT
• PLATFORM_RATE_LIMIT
• PLATFORM_ERROR
• ACCOUNT_RESTRICTED
• LINKEDIN_AUTH_FAILED
• LINKEDIN_FEATURE_NOT_SUBSCRIBED
• RESOURCE_NOT_FOUND
• TIER_NOT_ACTIVE

All error codes link to Error codes reference.

Notes

Note: The account_id is injected automatically by the account-scoped accessor. Call as curviate.account("acc_YOUR_ACCOUNT_ID").recruiter.listApplicants(...).