---
title: "Turn text into the ids LinkedIn filters take"
method: GET
path: "/search/linkedin/parameters"
tags: ["search"]
---

# Turn text into the ids LinkedIn filters take

`GET /search/linkedin/parameters`

Resolve a written label (an industry, a company, a place, a school) into the identifier a search filter needs. Worth knowing why this exists: a filter given an id it does not recognise is accepted and ignored, so a search built on a guessed id quietly returns the unfiltered set and reads as a market with nobody in it. Leaving the keywords empty on a closed-value type lists every option, which is the way to answer what the available buckets are.

## Query parameters

- `type` string, required — Which kind of value to resolve. Entity kinds resolve live; the closed-value kinds resolve from a dictionary and need no connected account.
- `keywords` string — The text to resolve. Empty on a closed-value type lists every option.
- `limit` integer

## Response `200`

Matching ids, or a hint explaining why there were none

- object
  - `success` true, required
  - `items` object[], required
    - `id` string, required — The id LinkedIn's own filters take.
    - `title` string, required — Human-readable label for the id.
    - `type` string, required — Echo of the requested type.
    - `displayValue` string — Present on the closed-enum types.
    - `source` string — Where the id came from: LinkedIn's typeahead, the curated alias map, or a Sales Navigator enum snapshot.
    - `aliasKind` string — Present when the curated alias map answered.
  - `count` integer, required
  - `hint` string — Present ONLY when nothing matched, and it says why rather than leaving an empty array to be read as an empty world.
  - `aliasResolved` boolean, required — True when the curated alias map answered rather than LinkedIn.
  - `creditsUsed` integer, required — Credits consumed by this call. 0 for free endpoints, cached results, duplicates, and for every query that does not touch LinkedIn.
  - `retryAfter` integer, required — Seconds to wait before another call of the same type. 0 means no wait is needed.
  - `_meta` object — Credit balance carried on every response so a caller never has to ask for it separately. Absent when the caller has no connected account.
    - `credits` object, required
      - `current` number, required — Credits spent this period.
      - `limit` number, nullable, required — Period allowance, or null when unlimited.
      - `remaining` number, nullable, required — Allowance left, or null when unlimited.
      - `percentage` number, required — Share of the allowance spent, 0 to 100.
      - `isUnlimited` boolean, required
      - `accountPlan` string, required — The credential's plan.

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error.
- `401` — Although HTTP specifies "unauthorized", this response means "unauthenticated". Authenticate to continue. NOTE: 401 is also returned with code "linkedin_not_connected" when the caller IS authenticated but has no connected LinkedIn account — connect LinkedIn (not re-authenticate) to continue.
- `403` — The client does not have access rights to the content.
- `404` — The server cannot find the requested resource.
- `409` — The request conflicts with the current state of the server.
- `410` — The requested content has been permanently deleted from the server.
- `422` — The request was well-formed but was unable to be followed due to semantic errors.
- `429` — Rate limit exceeded. Read error.retryAfter for the wait time in seconds.
- `500` — The server encountered a situation it does not know how to handle.
- `502` — LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.
- `503` — Proxy capacity temporarily exceeded. Retry after a few seconds.

---

[API](https://skmtc.net/berea/apis/bereach-api.md) · [All operations](https://skmtc.net/berea/apis/bereach-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/berea/bereach-api/revisions/a1e86af2406d/schema)