search.getParameters

Resolve human-readable terms to opaque filter IDs for structured search.

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

getParameters(query: SearchParametersQuery): Promise<SearchParametersResult>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
let cursor: string | null | undefined;
do {
  const page = await curviate.account("acc_123").search.getParameters({
    type: "SKILL",
    keywords: "software development",
    ...(cursor ? { cursor } : {}),
  });
  for (const item of page.items) console.log(item.id, item.name);
  cursor = page.cursor;
} while (cursor);

Parameters

NameTypeRequiredDescription
typestringYesParameter type to resolve. Non-classic types (e.g. GROUPS, SALES_INDUSTRY) are rejected.
keywordsstringYesHuman term to resolve to opaque filter IDs (e.g. 'software development'). Required for every type, including EMPLOYMENT_TYPE.
offsetnumberNoZero-based pagination offset; a numeric fallback for cursor (default 0).
limitnumberNoNumber of parameters to return (1-100, default 10).
cursorstringNoOpaque pagination cursor returned from a previous response.

Returns

Resolves to SearchParametersResult. Top-level fields: object, items, cursor, 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.
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