accounts.list

List the tenant's connected LinkedIn accounts, cursor-paginated.

Prerequisites

A Curviate API key, passed as apiKey when you construct the client. Quickstart shows how to create one.

Signature

list(params?: AccountListParams): Promise<AccountListPage>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const { items } = await curviate.accounts.list({ external_id: "usr_42" });

Parameters

Name	Type	Required	Description
`limit`	`number`	No	Number of accounts to return per page (1-250, default 50).
`cursor`	`string`	No	Opaque pagination cursor from a prior page's `cursor` field. Omit for the first page.
`external_id`	`string`	No	Return only accounts whose external_id equals this value exactly.

Returns

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

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

Quickstart: connect a LinkedIn account. An empty account list means the key works and nothing is connected yet.
accounts.listSeats: List the workspace's live seats: each seat_id, whether an account occupied it, and that account_id (null when free).
accounts.get: Return metadata and current state for one connected account, including the central quotas[] account-safety view, account_states[] and seat_id (the seat this account occupies, null for an admin seatless account).
SDK Quick Start: installation, the client, account scoping, and pagination.