cURL
curl --request GET \
--url https://api.firmable.com/filter-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.firmable.com/filter-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.firmable.com/filter-options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firmable.com/filter-options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.firmable.com/filter-options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.firmable.com/filter-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firmable.com/filter-options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"markets": [
{
"code": "AU",
"label": "Australia"
}
],
"filters": [
{
"identifier": "industry",
"label": "Industry",
"group": "company",
"kind": "list",
"endpoints": [
"company_search"
],
"accepts": "<string>",
"counts": "per_market",
"values": [
{
"code": "l1:J",
"label": "Industrial and manufacturing"
}
],
"page": {
"offset": 0,
"size": 20,
"total": 20
}
}
]
}{
"error": {
"code": "invalid_request",
"reason": "Unknown filter identifier: bogus."
}
}{
"error": {
"code": "invalid_request",
"reason": "Unknown filter identifier: bogus."
}
}Reference
Filter options
List every search filter and the codes it accepts
GET
/
filter-options
cURL
curl --request GET \
--url https://api.firmable.com/filter-options \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.firmable.com/filter-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.firmable.com/filter-options', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firmable.com/filter-options",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.firmable.com/filter-options"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.firmable.com/filter-options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firmable.com/filter-options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"markets": [
{
"code": "AU",
"label": "Australia"
}
],
"filters": [
{
"identifier": "industry",
"label": "Industry",
"group": "company",
"kind": "list",
"endpoints": [
"company_search"
],
"accepts": "<string>",
"counts": "per_market",
"values": [
{
"code": "l1:J",
"label": "Industrial and manufacturing"
}
],
"page": {
"offset": 0,
"size": 20,
"total": 20
}
}
]
}{
"error": {
"code": "invalid_request",
"reason": "Unknown filter identifier: bogus."
}
}{
"error": {
"code": "invalid_request",
"reason": "Unknown filter identifier: bogus."
}
}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
curl "https://api.firmable.com/filter-options?identifiers=location&search=new%20south" \
-H "Authorization: Bearer $FIRMABLE_KEY"
Response · 200
{
"markets": [ … 13 markets ],
"filters": [
{
"identifier": "location",
"kind": "location",
"values": [ { "code": "state:NSW, AU:AU", "label": "New South Wales, AU" } ],
"page": { "offset": 0, "size": 20, "total": 1 }
}
]
}
Authorizations
Query Parameters
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