--- title: "Search companies" method: POST path: "/v1/{account_id}/search/companies" tags: ["Search"] --- # Search companies `POST /v1/{account_id}/search/companies` ## Request - Base URL: `https://api.curviate.com` - URL: `https://api.curviate.com/v1/{account_id}/search/companies` - Auth: HTTP bearer Searches LinkedIn companies using structured filters. To search from a pasted LinkedIn search URL instead, use POST .../search. No company description or tagline is returned. ## Path parameters - `account_id` string, required ## Query parameters - `offset` integer - `limit` integer - `cursor` string ## Request body - object - `keywords` string: Full-text keyword search across company profiles. - `industry` string[]: Opaque industry IDs from GET .../search/parameters?type=INDUSTRY. - `location` string[]: Opaque location IDs from GET .../search/parameters?type=LOCATION. - `has_job_postings` boolean: Filter to companies with active job postings. - `headcount` object[]: Filter by company size buckets. Each entry is a { min, max } object (e.g. { min: 51, max: 200 }). - `min` integer, required: Lower bound of a company-size bucket. Valid values: 1, 11, 51, 201, 501, 1001, 5001, 10001. - `max` integer, required: Upper bound of a company-size bucket. Valid values: 1, 10, 50, 200, 500, 1000, 5000, 10000. ## Response `200` A page of companies matching the filters. No company description, tagline, or mission is returned. - object - `object` 'company_search_result', required: Response type discriminator. - `items` object[], required: Company search result items. - `id` string, required: Numeric LinkedIn company identifier. - `name` string: Company display name. Present when available. - `public_identifier` string: LinkedIn public identifier (vanity slug). Present when available. - `location` string: Company headquarters location. Present when available. - `industry` string: Industry the company operates in. Present when available. - `summary` string: Company summary text. Present when available. - `job_offers_count` number: Open job offer count. Present when available. - `profile_url` string: Company LinkedIn profile URL. Present when available. - `followers_count` number: Follower count. Present when available. - `relations_count` number: Count of the authenticated account's connections at this company. Present when available. - `avatar_url` string: Company logo URL. Present when available. - `paging` object, required: Paging metadata. - `total_count` number, nullable, required: Always null on this search. LinkedIn stopped reporting how many results match, so there is no total to page toward; walk the pages with cursor until it comes back null. A short or empty page is not the end: only a null cursor is. - `cursor` string, nullable, required: Opaque next-page cursor; null on the last page. - `notices` object[]: Present only when there is something to report about this page. Each entry names a condition that is true of the response but not visible in it, so a result set is never misleading by omission. Absent when there is nothing to report. - `code` 'FILTER_VALUE_UNRESOLVED' | 'FILTER_VALUE_UNCHECKED' | 'SOME_RESULTS_HIDDEN' | 'ALL_RESULTS_HIDDEN' | 'PAGE_TRUNCATED', required: FILTER_VALUE_UNRESOLVED: the value matched no known filter option, so it was sent on as an id we could not check. FILTER_VALUE_UNCHECKED: the value already looked like an id, so it was never looked up, and this page came back empty. SOME_RESULTS_HIDDEN: some people on this page were not disclosed to the connected account, so those entries cannot be read back. ALL_RESULTS_HIDDEN: none of the people on this page were disclosed, so the page yielded nothing you can act on, even when more pages follow. PAGE_TRUNCATED: this page is short because the search stopped fetching upstream pages, not because the results ran out; follow cursor, and treat only a null cursor as the end. Branch on this rather than on message. - `message` string, required: One sentence explaining the condition and how to resolve it. - `field` string: The request field the notice is about, dotted for nested filters. - `value` string: The offending value. - `safety_warning` SafetyWarning: Present on a successful response when this account crossed an account-safety ceiling while the affected budget row is on the default warn posture. The action still happened. Field-identical to the BUDGET_EXHAUSTED error body except that blocked is false and hint.message describes the outcome, so one branch handles both postures and switching the account to enforce is a configuration change rather than a client rewrite. - `row` string, nullable, required: The budget row that breached, for example profile_views or pending_invites. Null when the breach is not about a row: an activity_window warning on an action that spends no budget of its own (editing a message, dismissing a notification, a Recruiter or Sales Navigator admin action) is still governed by the hours the account works in. Read hint.parameter for what to change; whenever this is null it names posture, because the activity window edges are set per action type and this action has none, so the levers that reach it are the account timezone and posture. - `reset_at` string, nullable, required: The instant the refusal lifts: the window roll on a ceiling refusal, the next window open on an activity-window one. Null in the two cases no clock frees, the pending_invites gauge and InMail credits (row inmail). - `hint` object, required - `parameter` string, required: The settable parameter on PATCH /v1/{account_id}/safety-policy. - `message` string, required: What the condition is and what changing that parameter would do. This is the one field whose text differs from the BUDGET_EXHAUSTED refusal: here it says the action went through, and on a ceiling breach how far past the ceiling this row now stands, rather than telling you to set posture to warn when it already is. Branch on parameter, reason and blocked, never on this text. - `reason` 'ceiling' | 'activity_window', required: Which rule was crossed. ceiling means the row's configured limit is spent; activity_window means the account is outside the hours it works in, which is a different fact with a different remedy. hint.parameter names the right setting for each. - `blocked` boolean, required: Always false here. True on the BUDGET_EXHAUSTED refusal carrying the same payload. ## Other responses - `400`: Invalid request body, malformed filter, malformed cursor, or limit outside the 2-50 range (companies require limit >= 2). A filter value that matches no filter option is NOT rejected here: it is sent on as an id and reported in notices[] on the 200, because a value we cannot resolve by name may still be a valid id. - `401`: Missing or invalid API key. - `404`: The supplied account_id does not belong to this tenant. An id whose connection was replaced or removed also stops resolving here, and it is already absent from the list, so re-read `GET /v1/accounts` for the current id. - `413`: Payload too large, the request body exceeds the size limit. - `422`: Either FILTER_CANDIDATES_REQUIRED, meaning a filter value matched several options and you must choose one, or ACCOUNT_RESTRICTED, meaning the connected account cannot perform searches. On FILTER_CANDIDATES_REQUIRED the body carries unresolved[], listing every offending field with its value and the candidate ids to pick from, plus a next_action sentence. Re-send the request with a chosen id. - `429`: Rate limited, slow down and retry after the hinted delay. - `500`: Internal error. - `502`: A temporary error occurred. Please try again. - `503`: Service unavailable. - `504`: Gateway timeout. --- [API](https://skmtc.dev/curviate/apis/curviate-api.md) · [All operations](https://skmtc.dev/curviate/apis/curviate-api/llms.txt) · [OpenAPI document](https://skmtc.dev/curviate/apis/curviate-api/revisions/eab848801d95?raw)