search.getServiceParameters
Resolve human-readable service-filter terms into the opaque ids services() accepts.
Prerequisites
- A Curviate API key, passed as
apiKeywhen you construct the client. Authentication and accounts shows how to create one. - A connected LinkedIn account. This resource is account-scoped: the
account_idis injected automatically by the account-scoped accessor, so you pass it once tocurviate.account(...)and every call below inherits it. Authentication and accounts covers connecting one, and accounts.list returns theaccount_idof each account already connected.
Signature
getServiceParameters(query: SearchServiceParametersQuery): Promise<SearchServiceParametersResult>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.getServiceParameters({ keywords: "marke" });
for (const item of page.items ?? []) {
console.log(item.id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).Parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | string | No | The service-filter type to resolve: service_category (the 'Add a service category' typeahead) or location (the 'Add a location' typeahead). |
keywords | string | Yes | The typed text to resolve (e.g. 'marke'). |
limit | number | No | Maximum options to return (1-100, default 10). |
cursor | string | No | Opaque pagination cursor returned from a previous response. |
offset | number | No | Zero-based pagination offset; a numeric fallback for cursor (default 0). |
Returns
Resolves to SearchServiceParametersResult. 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. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
RESOURCE_NOT_FOUND | The 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
search.getParameters: Resolve human-readable terms to opaque filter IDs for structured search.search.companies: Search companies with structured filters.search.fromUrl: Run a pasted LinkedIn search/saved-search/lead-list URL directly.- SDK Quick Start: installation, the client, account scoping, and pagination.