search.posts

Search posts with structured filters.

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

posts(body: SearchPostsBody & SearchPostsQuery): Promise<SearchPostsResult>

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

Parameters

NameTypeRequiredDescription
offsetnumberNoZero-based pagination offset (default 0).
limitnumberNoMaximum results per page (1-50, default 10).
cursorstringNoOpaque pagination cursor returned from a previous response.
keywordsstringNoFull-text keyword search in posts.
sort_bystringNoSort order: relevance (default) or date (newest first).
date_postedstringNoFilter by post recency.
content_typestringNoFilter by content type (single value, not an array).
posted_byobjectNoFilter to posts by specific authors (members, companies, yourself, connections, or people you follow).
mentioningobjectNoFilter to posts mentioning specific members or companies.
authorobjectNoFilter to posts by author attributes (industry, company, or keywords).

Returns

Resolves to SearchPostsResult. Top-level fields: object, items, paging, cursor, notices, 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.
ACCOUNT_RESTRICTEDLinkedIn has restricted the account, so it cannot act until that is cleared. Retrying will not help.
FILTER_CANDIDATES_REQUIREDA filter value matched several LinkedIn taxonomy options, so it cannot resolve without a choice. Re-send with a candidate id from the body's unresolved[]; this is not retryable as sent.
INTERNALAn unexpected server error. Retry once; if it persists, it is ours, not yours.
PAYLOAD_TOO_LARGEThree limits can trigger this. The platform's own ceiling on total request size is the lowest and the one you are most likely to hit: it starts rejecting at roughly 1 MB, so a handful of photo-sized images is refused even though it clears everything below. Above that, this API caps one attachment at 5 MiB of file content and the whole request body at 9 MiB. Attachments travel base64-encoded, which inflates them by about a third, so a 5 MiB file costs roughly 6.7 MiB of the body budget. Send fewer or smaller attachments; retrying unchanged will not help.
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