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").

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

list(params?: InboxListQuery): Promise<InboxListPage>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const acc = curviate.account("acc_YOUR_ACCOUNT_ID");
const { items, hint } = await acc.inboxes.list({ kind: "company" });
const companyPage = (items ?? []).find((i) => i.kind === "company");
console.log(companyPage?.id, companyPage?.name, hint);
// companyPage?.id is what you pass to listChats(), e.g. "COMPANY_83734124_PRIMARY"

Parameters

Name	Type	Required	Description
`kind`	`string`	No	Filter to only personal (CLASSIC_) or only company (COMPANY_) inboxes. Omit to list both.
`company_id`	`string`	No	Filter to the one company inbox correlated to this managed-company id (e.g. '112013061').

Returns

Resolves to InboxListPage. Top-level fields: object, items, hint, 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

inboxes.listChats: List an inbox's conversations, newest-activity-first, cursor-paginated.
SDK Quick Start: installation, the client, account scoping, and pagination.