companies.searchChats
Search or filter a company page's admin inbox.
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
searchChats(identifier: string, params?: CompanyChatSearchQuery): Promise<CompanyChatSearchPage>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").companies.searchChats("YOUR_COMPANY_ID");
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 |
|---|---|---|---|
identifier | string | Yes | The company's numeric id (e.g. 112013061), the id field of GET /v1/{account_id}/companies/{identifier} or a POST /v1/{account_id}/search/companies result. A public handle or URN is not accepted here; pass the numeric id. |
query | string | No | Free-text mode: matches participant names AND message content. Mutually exclusive with topic and unread. |
topic | string | No | Filter mode, one inbox topic card: 1-5 or its name (Service request, Request a demo, Support, Careers, Other). Mutually exclusive with query and unread. |
unread | boolean | No | Filter mode: unread conversations only. Pass unread=true. Mutually exclusive with query and topic. |
limit | number | No | Number of conversations to return per page (1-50, default 20). |
cursor | string | No | Opaque pagination cursor from a prior response's cursor. Omit for the first page. |
expand | string | No | Additional response fields to resolve, comma-separated in a single value (for example expand=public_identifier). Accepted values: public_identifier. When requested, the field is present on every user object in the response, carrying either a value or null. Omit for the base fields only. Pass the parameter once; repeating it drops values. At most 25 people per request need an extra lookup to resolve; anyone beyond that carries null, so ask for a smaller page to resolve them all. |
Returns
Resolves to CompanyChatSearchPage. Top-level fields: object, items, cursor, filter_effective, notices.
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 | A transient upstream failure. Retry once with backoff before treating it as a real error. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
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. |
TIER_NOT_ACTIVE | The seat does not have the add-on this endpoint needs. Enable it on the seat, then retry. |
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.get: Retrieve a company's full LinkedIn profile.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.