Retrieve LinkedIn search parameters

GEThttps://api.postpress.ai/v1/linkedin/search/parameters

Resolve raw keywords to the LinkedIn IDs required by the search endpoints.

LinkedIn does not accept raw text as search parameters - it requires stable IDs. This route resolves your inputs (locations, companies, industries, skills, ...) into the IDs you then pass to POST /linkedin/search.

Authorization

X-API-KEYstringrequired
API key from your postpress dashboard. Sent as a request header.

Query parameters

account_idstringrequired
The id of the account to trigger the request from.
typestringrequired
The kind of parameter to resolve. Common values work on all services. Sales Navigator and Recruiter expose additional types (see below).
servicestringoptional
Which LinkedIn API to query for common parameters. Defaults to `CLASSIC`.
keywordsstringoptional
Keywords to start the search from. Not applicable to `EMPLOYMENT_TYPE`.
limitintegeroptional
Number of items returned (1-100). Defaults to 10.

Type values by service

  • Common (any service): LOCATION, PEOPLE, CONNECTIONS, COMPANY, SCHOOL, INDUSTRY, SERVICE, JOB_FUNCTION, JOB_TITLE, EMPLOYMENT_TYPE, SKILL
  • Sales Navigator only: GROUPS, SALES_INDUSTRY, DEPARTMENT, PERSONA, ACCOUNT_LISTS, LEAD_LISTS, TECHNOLOGIES, SAVED_ACCOUNTS, SAVED_SEARCHES, RECENT_SEARCHES, REGION, POSTAL_CODE
  • Recruiter only: GROUPS, DEPARTMENT, HIRING_PROJECTS, SAVED_SEARCHES, SAVED_FILTERS, DEGREE

Response 200 OK

objectstringLinkedinSearchParametersListrequired
itemsarray of objectsrequired
items object
objectstringLinkedinSearchParameterrequired
idstringrequired
Stable LinkedIn identifier to pass back to search filters.
titlestringrequired
picture_urlstring
additional_dataobject
Free-form metadata that varies by `type` (e.g. headline, country, member counts). Values are strings, numbers, or booleans.
pagingobjectrequired
paging object
page_countnumberrequired

Example request

curl --request GET \
  --url 'https://api.postpress.ai/api/v1/linkedin/search/parameters?account_id=acc_linkedin_01HXYZ4QK3WJ8FN3M6QH7TZ8GR&type=LOCATION&keywords=San%20Francisco&limit=10' \
  --header 'X-API-KEY: pp_live_...' \
  --header 'accept: application/json'

Example response

{
  "object": "LinkedinSearchParametersList",
  "items": [
    {
      "object": "LinkedinSearchParameter",
      "id": "102277331",
      "title": "San Francisco, California, United States",
      "additional_data": {
        "country": "United States",
        "type": "CITY"
      }
    },
    {
      "object": "LinkedinSearchParameter",
      "id": "90000084",
      "title": "San Francisco Bay Area",
      "additional_data": {
        "country": "United States",
        "type": "METRO"
      }
    }
  ],
  "paging": { "page_count": 2 }
}

Errors

Every error response follows the same envelope:

titlestringrequired
Short error title.
detailstringoptional
Human-readable explanation.
instancestringoptional
Request identifier for support.
typestringrequired
Error type identifier.
statusnumberrequired
HTTP status code.
400 Bad Request8 types

The request itself is malformed.

  • errors/invalid_parameters - One or more parameters are invalid (e.g. unknown `type` for the selected `service`).
  • errors/malformed_request - The request is malformed.
  • errors/content_too_large - The request is too large.
  • errors/invalid_url - The provided URL is not valid.
  • errors/too_many_characters - A string parameter exceeds the allowed length.
  • errors/unescaped_characters - A parameter contains characters that must be encoded.
  • errors/missing_parameters - A required parameter (`type` or `account_id`) is missing.
  • errors/limit_too_high - `limit` exceeds the maximum (100).
401 Unauthorized13 types

Credentials are missing, expired, or otherwise invalid.

  • errors/missing_credentials - Some credentials are necessary to perform the request.
  • errors/multiple_sessions - LinkedIn limits multiple sessions on certain Recruiter accounts. Use the cookie connection method.
  • errors/wrong_account - The provided credentials do not match the correct account.
  • errors/invalid_credentials - The provided credentials are invalid.
  • errors/invalid_proxy_credentials - The provided proxy credentials are invalid.
  • errors/invalid_checkpoint_solution - The checkpoint resolution did not pass successfully. Retry.
  • errors/checkpoint_error - The checkpoint does not appear to be resolvable.
  • errors/expired_credentials - Credentials have expired. Reconnect the account.
  • errors/expired_link - This link has expired. Generate a new one.
  • errors/insufficient_privileges - This resource is out of your API-key scopes.
  • errors/disconnected_account - The account is disconnected from the provider service.
  • errors/disconnected_feature - The service you're trying to reach is disconnected.
  • errors/invalid_credentials_but_valid_account_imap - IMAP/SMTP credentials are invalid but the account is otherwise valid.
403 Forbidden9 types

Authenticated but the account is restricted or the action is not allowed.

  • errors/insufficient_permissions - Valid authentication but insufficient permissions to perform the request.
  • errors/account_restricted - The account has been restricted by the provider.
  • errors/account_mismatch - This action cannot be done with your account.
  • errors/unknown_authentication_context - An additional step seems necessary to complete login.
  • errors/session_mismatch - Token user id does not match client session id.
  • errors/feature_not_subscribed - Sales Navigator or Recruiter is not subscribed on this account.
  • errors/subscription_required - A subscription is required to use this feature.
  • errors/resource_access_restricted - You don't have access to this resource.
  • errors/action_required - An additional step is required.
404 Not Found2 types

The targeted account or resource does not exist.

  • errors/resource_not_found - The requested resource was not found.
  • errors/invalid_resource_identifier - The provided identifier is not valid for this resource.
429 Too Many Requests1 types

Rate-limited by the upstream provider.

  • errors/too_many_requests - The provider cannot accept more requests at the moment. Retry later.
500 Internal Server Error3 types

Something went wrong on our side or with the upstream provider.

  • errors/unexpected_error - Something went wrong.
  • errors/provider_error - The provider is experiencing operational problems. Retry later.
  • errors/authentication_intent_error - The current authentication intent was killed after failure.
503 Service Unavailable5 types

postpress is temporarily unable to handle the request.

  • errors/no_client_session - No client session is currently running.
  • errors/no_channel - No channel to client session.
  • errors/no_handler - Handler missing for that request.
  • errors/network_down - Network is down on the server side. Retry shortly.
  • errors/service_unavailable - Service temporarily unavailable. Retry later.
504 Gateway Timeout1 types

The upstream provider did not respond in time.

  • errors/request_timeout - Request timed out. Retry, and contact support if it persists.
Updated May 2026