Skip to main content
GET
cURL

Description

Lists the filters the Partner API search endpoints accept, with the codes each filter takes, and the markets a search can be scoped to. Use it to build the filters and country parts of a search request. The list is the same for every caller and changes rarely, so fetch it once and cache it. The call is not charged.

Choosing filters

Pass identifiers to get only the filters you need. Without it, every filter is returned.
Separate identifiers with commas, or repeat the parameter: ?identifiers=industry&identifiers=location. An unknown identifier returns a 400 that lists the valid ones.

Searching and paging

Four filters have long code lists: industry, location, hq_location and people_location. Their values come 20 at a time, with a page object:
To find a value or see the next page, ask for one of these filters on its own and add:
  • search: text to match against a value’s label or code, case-insensitive.
  • offset: how many matching values to skip. The page size is always 20 and can’t be changed.
search and offset work with exactly one of those four filters in identifiers. With any other filter, or with more than one, the call returns 400.

Industry levels

Industry has two levels. By default, industry returns its top-level codes, such as l1:J. A top-level code matches every industry beneath it. To list the second-level codes under one top-level code, sorted A–Z by label, pass it as levelOne:
search and offset also work with levelOne.

Filter identifiers

Search endpoints: C = company search, P = people search, PC = people in a company. Text filters return no values; they take any text. Company filters on people search apply to the person’s employer.
A search with a code that isn’t in filter options returns 422 invalid_filter_value, naming the filter and the value.

Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

identifiers
enum<string>[]

Comma-separated filter identifiers to return. Returns every filter when omitted. (example: industry,company_size)

Available options:
industry,
location,
hq_location,
company_size,
global_company_size,
revenue,
company_type,
year_founded,
is_mnc,
b2b_vs_b2c,
target_market,
multiple_locations,
job_posts,
keywords,
services,
products,
position,
seniority,
department,
skills,
current_role_duration,
people_location

Text to match against a value's label or code, case-insensitive. Only with exactly one of industry, location, hq_location or people_location in identifiers. (example: new south)

Required string length: 1 - 100
offset
integer
default:0

How many matching values to skip. Pages are always 20 values. Only with exactly one of industry, location, hq_location or people_location in identifiers. (example: 20)

Required range: x >= 0
levelOne
string

A top-level industry code, to list its second-level codes, sorted A–Z by label. Only with identifiers=industry. (example: l1:J)

Pattern: ^l1:[A-Za-z]+$

Response

Filter options

markets
object[]
required

Markets a search can be scoped to, for the search body's country array.

filters
object[]
required