notifications.list

List the connected account's notification cards, newest first, plus the account-level unread_count (the unseen badge, NOT a count of items) and latest_published_at (a cheap poll watermark).

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?: NotificationListQuery): Promise<NotificationListPage>

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").notifications.list();
for (const item of page.items ?? []) {
  console.log(item.card_urn);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).

Parameters

NameTypeRequiredDescription
filterstringNoWhich notification stream to read (default all): jobs, mentions, my_posts, my_posts_comments/reactions/reposts. Any other value is a 400.
limitnumberNoMinimum notifications per page (1-100, default 20); the server returns whole pages up to this boundary. Page until cursor is null.
cursorstringNoOpaque cursor from a prior response's cursor; omit for the first page, pass back verbatim. Poll unread_count instead of deep-paging.

Returns

Resolves to NotificationListPage. Top-level fields: object, items, cursor, unread_count, latest_published_at, safety_warning.

Error codes

CodeWhat it means, and what to do
UNAUTHORIZEDThe API key is missing, malformed, or revoked. Check the key you passed to the client.
INVALID_REQUESTA parameter failed validation. The message names the offending field; fix the request rather than retrying it.
RATE_LIMIT_ACCOUNTThis account's own quota is exhausted. Wait for the window in the Retry-After header, then retry.
RATE_LIMIT_TENANTThe tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call.
PLATFORM_RATE_LIMITLinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account.
PLATFORM_ERRORAn 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_FOUNDNo connected account with that id belongs to this tenant. List your accounts to get a current id.
INTERNALAn unexpected server error. Retry once; if it persists, it is ours, not yours.
NO_ACTIVE_SEATThe targeted account is not on an active seat. Buy or attach a seat in Billing, then retry.
RESOURCE_NOT_FOUNDThe 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

  • notifications.delete: Delete one of the connected account's own notification cards by its card urn.
  • notifications.showLess: Apply "show less like this" to the source of one of the connected account's own notification cards, a self-action, same card handle and timing/retry contract as delete.
  • SDK Quick Start: installation, the client, account scoping, and pagination.