search

Turn text into the ids LinkedIn filters take

Changed on

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.

get/search/linkedin/parameters

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/search/linkedin/parameters
  • Auth: HTTP bearer

Query parameters

typestring required

Which kind of value to resolve. Entity kinds are looked up when asked; the closed-value kinds come from a fixed list.

keywordsstring

The text to resolve. Empty on a closed-value type lists every option.

limitinteger

Response

Matching ids, or a hint explaining why there were none

successtrue required
countinteger required
hintstring

Present ONLY when nothing matched, and it says why rather than leaving an empty array to be read as an empty world.

aliasResolvedboolean required

True when the curated alias map answered rather than LinkedIn.

creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes