companies.get
Retrieve a company's full LinkedIn 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(identifier: string): Promise<CompanyProfile>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").companies.get("YOUR_COMPANY_ID");
console.log(result.id);Parameters
| Name | Type | Required | Description |
|---|---|---|---|
identifier | string | Yes | The company to retrieve. Accepts the company's public handle (the slug in linkedin.com/company/<handle>, e.g. t-systems) or its numeric id (e.g. 1234567). The numeric id field returned on each POST /v1/{account_id}/search/companies result, or the id field of this endpoint's own response, can be passed here directly. |
Returns
Resolves to CompanyProfile. Top-level fields: object, id, name, description, public_identifier, profile_url, public_picture_url, tagline, follower_count, is_active, is_archived, is_verified, verified_at, phone, funding, acquired_by, hashtags, locations, industry, website, establishment_year, fields_of_expertise, insights, 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. |
NO_ACTIVE_SEAT | The targeted account is not on an active seat. Buy or attach a seat in Billing, then retry. |
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
companies.searchChats: Search or filter a company page's admin inbox.companies.chat: Retrieve one conversation from a company page's admin inbox.companies.chats: List the conversations in a company page's admin message inbox, newest-activity-first.- SDK Quick Start: installation, the client, account scoping, and pagination.