This page documents the canonical HTTP contract. Switch to the CLI example when you want the operator workflow.
Usage
This endpoint uses the caller’s resolved LinkedIn connection and requires linkedin:read for developer API keys; authenticated user sessions are also accepted. It returns the provider’s parameter lookup response. Use the LinkedIn filter catalog as a guide to resolver types, then pass returned IDs in extra_params. Lookup results and accepted parameter types depend on provider service and account.
Example workflow
- Call this endpoint with
type: "REGION",linkedin_api: "sales_navigator", andkeywords: "San Francisco" - Get back
{ "id": "103644278", "name": "San Francisco Bay Area" } - Pass
"extra_params": { "location": ["103644278"] }in your search request
Body parameters
typerequiredstring
Provider parameter type to resolve. Common resolver types are listed by the filter catalog; accepted values can change with provider service and account.
keywords· optionalstring
Search text to match against. Default: empty (returns popular entries).
linkedin_api· optionalstring
Mode override: omit or use `auto` for the connected account mode, or use `classic` / `sales_navigator`. Availability and provider acceptance are not guaranteed.
limit· optionalinteger
Max results, 1–250. Default: 25.
| Name | Type | Description |
|---|---|---|
| typerequired | string | Provider parameter type to resolve. Common resolver types are listed by the filter catalog; accepted values can change with provider service and account. |
| keywords | string | Search text to match against. Default: empty (returns popular entries). |
| linkedin_api | string | Mode override: omit or use `auto` for the connected account mode, or use `classic` / `sales_navigator`. Availability and provider acceptance are not guaranteed. |
| limit | integer | Max results, 1–250. Default: 25. |
Errors
| Status | Meaning |
|---|---|
| 401 | Invalid API key or missing auth. |
| 403 | Developer API key lacks linkedin:read scope. |
| 400 | Organization/user context is missing, LinkedIn is not connected, or linkedin_api mode is invalid. |
| 424 | The connected account requires reconnect for this operation. |
| 429 | Account policy does not currently allow the lookup. |
| 502 | Fallback when the provider error has no HTTP status; a provider HTTP status may otherwise be returned. |
| 422 | Request body validation failed, including a limit outside 1–250 or missing type. |
| 503 | Unipile LinkedIn integration is not configured. |
