users.get
Retrieve a user's 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.
Signature
get(userId: string, params?: UserGetQuery): Promise<UserProfile>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").users.get("me");
console.log(result.id);Parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId | string | Yes | "me" for the caller's own account, or another LinkedIn user's public identifier, member ID, or profile URL. Note on the skills section: a skill's endorsement_id (the value needed to endorse that skill) is returned only for users you are eligible to endorse; i.e. your 1st-degree connections. For users outside your network, and on your own profile, the skills section still lists each skill (name, endorsement_count, endorsed, insights) but omits endorsement_id. This depends on the connection, not on the identifier form used to look the user up. |
linkedin_sections | array | No | Which profile sections to fetch (repeatable, flat). Pass one or more of: linkedin_experience, linkedin_education, linkedin_languages, linkedin_skills, linkedin_certifications, linkedin_volunteer_experience, linkedin_projects, linkedin_recommendations, linkedin_interests (or linkedin_* for all), plus each value's _preview variant. Omit for base fields only. |
mode | string | No | How willing this read is to reach LinkedIn. auto (default) serves a stored copy while it is within the resource's freshness threshold; live always fetches; refill serves a stored copy at any age and fetches once when this read has no stored copy yet; cache_only never fetches and returns NOT_STORED when nothing is stored. cache_only cannot be combined with max_age. A 502 under cache_only means the store could not be read, not that nothing is stored: no request was made to LinkedIn, and the same read is worth retrying. |
max_age | number | No | Maximum age, in seconds, of a stored copy this read will accept. Overrides the auto, live and refill presets in both directions; 0 is the same as mode=live. Not accepted with mode=cache_only, whose guarantee is not a freshness threshold. |
Returns
Resolves to UserProfile. Top-level fields: object, id, type, display_name, first_name, last_name, public_identifier, profile_url, public_picture_url, public_picture_url_large, private_picture_download_url, background_picture_url, description, bio, location, created_at, emails, phone_numbers, social_handles, websites, is_blocked, is_following, is_verified, is_premium, language, followers_count, relations_count, specifics, observed_at, source, withdrawn, withdrawn_at, safety_warning.
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 | An upstream failure, usually transient: retry once with backoff before treating it as a real error. Check the response first, though. When it carries retry_likely_to_succeed: false and retry_hint: {kind: "never"}, retrying cannot help and backing off only delays the real answer. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
LINKEDIN_FEATURE_NOT_SUBSCRIBED | The connected LinkedIn account does not have the subscription this operation needs. Activate it on LinkedIn; reconnecting will not help. |
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. |
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
users.listFollowers: List a user's followers.users.listFollowing: List who a user follows.users.listRelations: List the account's 1st-degree connections.- SDK Quick Start: installation, the client, account scoping, and pagination.