recruiter.getProfile
Retrieve a Recruiter-enriched profile.
Prerequisites
- A Curviate API key, passed as
apiKeywhen you construct the client. Authentication and accounts shows how to create one. - A connected LinkedIn account. This resource is account-scoped: the
account_idis injected automatically by the account-scoped accessor, so you pass it once tocurviate.account(...)and every call below inherits it. Authentication and accounts covers connecting one, and accounts.list returns theaccount_idof each account already connected. - Requires the Recruiter add-on on the seat. Without it, calls return
TIER_NOT_ACTIVE(403).
Signature
getProfile(identifier: string, params?: Partial<RecruiterGetProfileQuery>): Promise<RecruiterGetProfileResult>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.getProfile("me");
console.log(result.id);Parameters
| Name | Type | Required | Description |
|---|---|---|---|
identifier | string | Yes | The target profile: 'me', a public identifier, or a member ID. |
with_sections | array | No | Which recruiter profile sections to fetch (repeatable, flat). Allowed values: linkedin_*, linkedin_experience, linkedin_education, linkedin_languages, linkedin_skills, linkedin_certifications, linkedin_volunteer_experience, linkedin_projects, linkedin_recommendations, linkedin_interests, linkedin_recruiting_activity, and the _preview variant of each. Omit for base fields only. |
Returns
Resolves to RecruiterGetProfileResult. Top-level fields: object, id, type, display_name, provider, first_name, last_name, public_identifier, profile_url, public_picture_url, public_picture_url_large, description, location, specifics, recruiting_profile.
Error codes
| Code | What it means, and what to do |
|---|---|
UNAUTHORIZED | The API key is missing, malformed, or revoked. Check the key you passed to the client. |
INVALID_REQUEST | A parameter failed validation. The message names the offending field; fix the request rather than retrying it. |
RATE_LIMIT_ACCOUNT | This account's own quota is exhausted. Wait for the window in the Retry-After header, then retry. |
RATE_LIMIT_TENANT | The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call. |
PLATFORM_RATE_LIMIT | LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account. |
PLATFORM_ERROR | A transient upstream failure. Retry once with backoff before treating it as a real error. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
ACCOUNT_RESTRICTED | LinkedIn has restricted the account, so it cannot act until that is cleared. Retrying will not help. |
LINKEDIN_AUTH_FAILED | LinkedIn rejected the credentials. Confirm them with the account owner. |
LINKEDIN_FEATURE_NOT_SUBSCRIBED | The seat has the add-on but the LinkedIn account itself lacks the underlying subscription. |
RESOURCE_NOT_FOUND | The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it. |
TIER_NOT_ACTIVE | The seat does not have the add-on this endpoint needs. Enable it on the seat, then retry. |
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.listApplicants: List applicants in a project's talent pool (POST-as-list; the body carries filters, no state mutates).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.