cURL
curl --request POST \
--url https://api.firmable.com/partner/{partner}/companies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"industry": [
"l1:R"
],
"location": [
"state:VIC, AU:AU"
],
"company_size": [
"range:100-"
]
},
"country": [
"AU"
],
"page": {
"from": 0,
"size": 25
}
}
'import requests
url = "https://api.firmable.com/partner/{partner}/companies/search"
payload = {
"filters": {
"industry": ["l1:R"],
"location": ["state:VIC, AU:AU"],
"company_size": ["range:100-"]
},
"country": ["AU"],
"page": {
"from": 0,
"size": 25
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
industry: ['l1:R'],
location: ['state:VIC, AU:AU'],
company_size: ['range:100-']
},
country: ['AU'],
page: {from: 0, size: 25}
})
};
fetch('https://api.firmable.com/partner/{partner}/companies/search', 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/partner/{partner}/companies/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'industry' => [
'l1:R'
],
'location' => [
'state:VIC, AU:AU'
],
'company_size' => [
'range:100-'
]
],
'country' => [
'AU'
],
'page' => [
'from' => 0,
'size' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firmable.com/partner/{partner}/companies/search"
payload := strings.NewReader("{\n \"filters\": {\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\n ],\n \"company_size\": [\n \"range:100-\"\n ]\n },\n \"country\": [\n \"AU\"\n ],\n \"page\": {\n \"from\": 0,\n \"size\": 25\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firmable.com/partner/{partner}/companies/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\n ],\n \"company_size\": [\n \"range:100-\"\n ]\n },\n \"country\": [\n \"AU\"\n ],\n \"page\": {\n \"from\": 0,\n \"size\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firmable.com/partner/{partner}/companies/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\n ],\n \"company_size\": [\n \"range:100-\"\n ]\n },\n \"country\": [\n \"AU\"\n ],\n \"page\": {\n \"from\": 0,\n \"size\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"records": [
{
"company_id": "f000000000101",
"name": "Harbourline Logistics",
"website": "https://www.harbourline.example",
"industry": [
{
"l2": "Logistics and supply chain services"
}
],
"hq_country": "AU",
"revenue": "4",
"global_company_size": "4",
"multiple_locations": "2",
"au": {
"employee_count": 312,
"company_size": 4,
"hq_location": [
{
"country": "AU",
"state": "VIC, AU"
}
],
"has_company_phone": true,
"has_company_mobile": false
}
}
],
"total": 86,
"page": {
"from": 0,
"size": 25
}
}Search
Company search
Find companies matching structured filters
POST
/
partner
/
{partner}
/
companies
/
search
cURL
curl --request POST \
--url https://api.firmable.com/partner/{partner}/companies/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"industry": [
"l1:R"
],
"location": [
"state:VIC, AU:AU"
],
"company_size": [
"range:100-"
]
},
"country": [
"AU"
],
"page": {
"from": 0,
"size": 25
}
}
'import requests
url = "https://api.firmable.com/partner/{partner}/companies/search"
payload = {
"filters": {
"industry": ["l1:R"],
"location": ["state:VIC, AU:AU"],
"company_size": ["range:100-"]
},
"country": ["AU"],
"page": {
"from": 0,
"size": 25
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
industry: ['l1:R'],
location: ['state:VIC, AU:AU'],
company_size: ['range:100-']
},
country: ['AU'],
page: {from: 0, size: 25}
})
};
fetch('https://api.firmable.com/partner/{partner}/companies/search', 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/partner/{partner}/companies/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'industry' => [
'l1:R'
],
'location' => [
'state:VIC, AU:AU'
],
'company_size' => [
'range:100-'
]
],
'country' => [
'AU'
],
'page' => [
'from' => 0,
'size' => 25
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firmable.com/partner/{partner}/companies/search"
payload := strings.NewReader("{\n \"filters\": {\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\n ],\n \"company_size\": [\n \"range:100-\"\n ]\n },\n \"country\": [\n \"AU\"\n ],\n \"page\": {\n \"from\": 0,\n \"size\": 25\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firmable.com/partner/{partner}/companies/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\n ],\n \"company_size\": [\n \"range:100-\"\n ]\n },\n \"country\": [\n \"AU\"\n ],\n \"page\": {\n \"from\": 0,\n \"size\": 25\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firmable.com/partner/{partner}/companies/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\n ],\n \"company_size\": [\n \"range:100-\"\n ]\n },\n \"country\": [\n \"AU\"\n ],\n \"page\": {\n \"from\": 0,\n \"size\": 25\n }\n}"
response = http.request(request)
puts response.read_body{
"records": [
{
"company_id": "f000000000101",
"name": "Harbourline Logistics",
"website": "https://www.harbourline.example",
"industry": [
{
"l2": "Logistics and supply chain services"
}
],
"hq_country": "AU",
"revenue": "4",
"global_company_size": "4",
"multiple_locations": "2",
"au": {
"employee_count": 312,
"company_size": 4,
"hq_location": [
{
"country": "AU",
"state": "VIC, AU"
}
],
"has_company_phone": true,
"has_company_mobile": false
}
}
],
"total": 86,
"page": {
"from": 0,
"size": 25
}
}Company search accepts every company and people filter. With people filters, it returns companies
where one person matches all of them together. See Filters for the filters and
the forms their codes take.
Each record carries one object per market searched, keyed by the lowercase market code. With people
filters, a page can return one record fewer than
page.size. total stays correct.
Codes such as "revenue": "4" are explained in Codes in responses.Authorizations
Path Parameters
Body
application/json