drafts.list

List Drafts, cursor-paginated.

Prerequisites

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

Signature

list(params?: DraftListParams): Promise<DraftListResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const page = await curviate.drafts.list({ status: ["scheduled"], order: "asc" });

Parameters

Name	Type	Required	Description
`status`	`array`	No	Comma list of draft, scheduled, failed, published. Default draft,scheduled,failed. published items are publish records, never Drafts.
`account_id`	`string`	No	Only items on this account (acc_...), or none for Drafts with no account. Omitted: all of yours.
`from`	`string`	No	Only items whose date is at or after this instant (inclusive).
`to`	`string`	No	Only items whose date is before this instant (exclusive).
`order`	`string`	No	Sort by the item's date: desc (default) or asc.
`limit`	`number`	No	Max items per page (1-100, default 20).
`cursor`	`string`	No	Pagination cursor from a previous response; pass it back verbatim with the same filters.

Returns

Resolves to DraftListResult. 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.

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

drafts.get: Return one Draft, with a fresh signed link (valid 1 hour) per attachment.
drafts.create: Store a Draft.
drafts.delete: Delete the Draft and its stored media (bodyless, 204).
SDK Quick Start: installation, the client, account scoping, and pagination.