inboxes.listChats
List an inbox's conversations, newest-activity-first, cursor-paginated.
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
listChats(inboxId: string, params?: InboxChatListQuery): Promise<InboxChatListPage>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").inboxes.listChats("YOUR_INBOX_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 |
|---|---|---|---|
inboxId | string | Yes | The inbox ID (e.g. 'CLASSIC_PRIMARY' or 'COMPANY_83734124_PRIMARY') from GET /inboxes. |
limit | number | No | Number of items to return per page (1-25, default 20). |
cursor | string | No | An opaque cursor for pagination. Pass the cursor from the preceding response to fetch the next 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 InboxChatListPage. Top-level fields: object, items, cursor, 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_ACCESS_RESTRICTED | The account can see the resource but is not permitted to act on it, typically an admin permission it does not hold. |
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
inboxes.list: List the account's inboxes: its own personal inbox, plus, when the company product is attached, one entry per company page (id like "COMPANY_83734124_PRIMARY").- SDK Quick Start: installation, the client, account scoping, and pagination.