Skip to main content
GET
cURL
Returns every filter the search endpoints accept, with its codes. Search accepts only codes that filter options lists. Lists refresh hourly. Filter options accepts any Firmable API key and is never charged. industry, location, hq_location and people_location return 20 values at a time with a page object. Every other filter returns all of its values. search, offset and levelOne require exactly one of these four filters in identifiers. industry returns its top-level codes unless levelOne is sent.

Searching a long list

Request
Response · 200

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