search.companies

Search companies with structured filters.

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

companies(body: SearchCompaniesBody & SearchCompaniesQuery): Promise<SearchCompaniesResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const page = await curviate.account("acc_YOUR_ACCOUNT_ID").search.companies({ keywords: "YOUR_KEYWORDS" });
for (const item of page.items ?? []) {
  console.log(item.id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).

Parameters

Name	Type	Required	Description
`offset`	`number`	No	Zero-based pagination offset (default 0).
`limit`	`number`	No	Maximum results per page (2-50, default 10). Company search requires a minimum of 2.
`cursor`	`string`	No	Opaque pagination cursor returned from a previous response.
`keywords`	`string`	No	Full-text keyword search across company profiles.
`industry`	`array`	No	Opaque industry IDs from GET.../search/parameters?type=INDUSTRY.
`location`	`array`	No	Opaque location IDs from GET.../search/parameters?type=LOCATION.
`has_job_postings`	`boolean`	No	Filter to companies with active job postings.
`headcount`	`array`	No	Filter by company size buckets. Each entry is a { min, max } object (e.g. { min: 51, max: 200 }).

Returns

Resolves to SearchCompaniesResult. Top-level fields: object, items, paging, cursor, notices, 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.
`ACCOUNT_RESTRICTED`	LinkedIn has restricted the account, so it cannot act until that is cleared. Retrying will not help.
`FILTER_CANDIDATES_REQUIRED`	A filter value matched several LinkedIn taxonomy options, so it cannot resolve without a choice. Re-send with a candidate id from the body's `unresolved[]`; this is not retryable as sent.
`INTERNAL`	An unexpected server error. Retry once; if it persists, it is ours, not yours.
`PAYLOAD_TOO_LARGE`	Three limits can trigger this. The platform's own ceiling on total request size is the lowest and the one you are most likely to hit: it starts rejecting at roughly 1 MB, so a handful of photo-sized images is refused even though it clears everything below. Above that, this API caps one attachment at 5 MiB of file content and the whole request body at 9 MiB. Attachments travel base64-encoded, which inflates them by about a third, so a 5 MiB file costs roughly 6.7 MiB of the body budget. Send fewer or smaller attachments; retrying unchanged 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

search.getParameters: resolve a human term into the opaque parameter ids the filters above take. Resolve first, then filter.
search.getServiceParameters: Resolve human-readable service-filter terms into the opaque ids services() accepts.
search.fromUrl: Run a pasted LinkedIn search/saved-search/lead-list URL directly.
SDK Quick Start: installation, the client, account scoping, and pagination.