messaging.searchChats

Free-text search the account's own inbox; matches participant names and message content.

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

searchChats(params: ChatSearchQuery): Promise<ChatSearchPage>

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").messaging.searchChats({ query: "YOUR_QUERY" });
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
`query`	`string`	Yes	Search term, matches participant names and message content. Minimum 3 characters.
`limit`	`number`	No	Maximum chats to return per page (1-100, default 20). The server may walk a few internal pages to fill one page.
`cursor`	`string`	No	Pagination cursor from a previous response; decodable, wraps a zero-based item offset, pass it back verbatim.

Returns

Resolves to ChatSearchPage. Top-level fields: object, items, cursor, coverage, 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.
`INTERNAL`	An unexpected server error. Retry once; if it persists, it is ours, not yours.
`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

messaging.listChats: List paginated chats for the account.
messaging.listMessages: List messages in a chat, cursor-paginated.
messaging.getAttachment: Download a message attachment.
SDK Quick Start: installation, the client, account scoping, and pagination.