companies.get

Retrieve a company's full LinkedIn profile.

Prerequisites

  • A Curviate API key, passed as apiKey when you construct the client. Quickstart 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. Quickstart covers connecting one, and accounts.list returns the account_id of 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

NameTypeRequiredDescription
identifierstringYesThe company to retrieve: its public handle (the linkedin.com/company/&lt;handle> slug) or numeric id. Both come back on a search/companies result.

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

CodeWhat it means, and what to do
UNAUTHORIZEDThe API key is missing, malformed, or revoked. Check the key you passed to the client.
INVALID_REQUESTA parameter failed validation. The message names the offending field; fix the request rather than retrying it.
RATE_LIMIT_ACCOUNTThis account's own quota is exhausted. Wait for the window in the Retry-After header, then retry.
RATE_LIMIT_TENANTThe tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call.
PLATFORM_RATE_LIMITLinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account.
PLATFORM_ERRORAn 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_FOUNDNo connected account with that id belongs to this tenant. List your accounts to get a current id.
INTERNALAn unexpected server error. Retry once; if it persists, it is ours, not yours.
NO_ACTIVE_SEATThe targeted account is not on an active seat. Buy or attach a seat in Billing, then retry.
RESOURCE_NOT_FOUNDThe 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.