cURL
curl --request POST \
--url https://api.firmable.com/partner/{partner}/people/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"seniority": [
"3"
],
"department": [
"14"
],
"industry": [
"l1:R"
],
"location": [
"state:VIC, AU:AU"
]
},
"country": [
"AU"
],
"page": {
"from": 0,
"size": 25
}
}
'import requests
url = "https://api.firmable.com/partner/{partner}/people/search"
payload = {
"filters": {
"seniority": ["3"],
"department": ["14"],
"industry": ["l1:R"],
"location": ["state:VIC, AU:AU"]
},
"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: {
seniority: ['3'],
department: ['14'],
industry: ['l1:R'],
location: ['state:VIC, AU:AU']
},
country: ['AU'],
page: {from: 0, size: 25}
})
};
fetch('https://api.firmable.com/partner/{partner}/people/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}/people/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' => [
'seniority' => [
'3'
],
'department' => [
'14'
],
'industry' => [
'l1:R'
],
'location' => [
'state:VIC, AU:AU'
]
],
'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}/people/search"
payload := strings.NewReader("{\n \"filters\": {\n \"seniority\": [\n \"3\"\n ],\n \"department\": [\n \"14\"\n ],\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\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}/people/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"seniority\": [\n \"3\"\n ],\n \"department\": [\n \"14\"\n ],\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\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}/people/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 \"seniority\": [\n \"3\"\n ],\n \"department\": [\n \"14\"\n ],\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\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": [
{
"id": "fp000000000201",
"name": "Jordan Lee",
"position": "Chief Financial Officer",
"company_name": "Harbourline Logistics",
"company_id": "f000000000101",
"has_email": true,
"has_phone": true,
"has_mobile": true,
"has_dnd_phone": false
}
],
"total": 41,
"page": {
"from": 0,
"size": 25
}
}Search
People search
Find people matching structured filters, including filters on their employer
POST
/
partner
/
{partner}
/
people
/
search
cURL
curl --request POST \
--url https://api.firmable.com/partner/{partner}/people/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"seniority": [
"3"
],
"department": [
"14"
],
"industry": [
"l1:R"
],
"location": [
"state:VIC, AU:AU"
]
},
"country": [
"AU"
],
"page": {
"from": 0,
"size": 25
}
}
'import requests
url = "https://api.firmable.com/partner/{partner}/people/search"
payload = {
"filters": {
"seniority": ["3"],
"department": ["14"],
"industry": ["l1:R"],
"location": ["state:VIC, AU:AU"]
},
"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: {
seniority: ['3'],
department: ['14'],
industry: ['l1:R'],
location: ['state:VIC, AU:AU']
},
country: ['AU'],
page: {from: 0, size: 25}
})
};
fetch('https://api.firmable.com/partner/{partner}/people/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}/people/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' => [
'seniority' => [
'3'
],
'department' => [
'14'
],
'industry' => [
'l1:R'
],
'location' => [
'state:VIC, AU:AU'
]
],
'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}/people/search"
payload := strings.NewReader("{\n \"filters\": {\n \"seniority\": [\n \"3\"\n ],\n \"department\": [\n \"14\"\n ],\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\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}/people/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"seniority\": [\n \"3\"\n ],\n \"department\": [\n \"14\"\n ],\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\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}/people/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 \"seniority\": [\n \"3\"\n ],\n \"department\": [\n \"14\"\n ],\n \"industry\": [\n \"l1:R\"\n ],\n \"location\": [\n \"state:VIC, AU:AU\"\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": [
{
"id": "fp000000000201",
"name": "Jordan Lee",
"position": "Chief Financial Officer",
"company_name": "Harbourline Logistics",
"company_id": "f000000000101",
"has_email": true,
"has_phone": true,
"has_mobile": true,
"has_dnd_phone": false
}
],
"total": 41,
"page": {
"from": 0,
"size": 25
}
}People search accepts every people and company filter. Company filters apply to the person’s
employer. See Filters for the filters and the forms their codes take.
Records carry contact availability flags only. Pass a record’s
id to
people enrichment for contact details.
Contact availability flags
| Flag | Meaning |
|---|---|
has_email | Firmable holds a work email for the person. |
has_phone | Firmable holds a phone number for the person. |
has_mobile | Firmable holds a mobile number for the person. |
has_dnd_phone | A phone number Firmable holds for the person is on a Do Not Call register. |
Authorizations
Path Parameters
Body
application/json