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. Authentication and accounts 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. Authentication and accounts 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

Returns

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

Error codes

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
• notifications.showLess
• SDK Quick Start: installation, the client, account scoping, and pagination.