List Audiences
curl --request POST \
--url https://api.example.com/api/public/tools/list_audiences \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"limit": null,
"cursor": null,
"searchQuery": null,
"includeLinkedAudiences": null,
"ids": null,
"names": null,
"sources": null,
"statuses": null
}
'import requests
url = "https://api.example.com/api/public/tools/list_audiences"
payload = {
"limit": None,
"cursor": None,
"searchQuery": None,
"includeLinkedAudiences": None,
"ids": None,
"names": None,
"sources": None,
"statuses": None
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
limit: null,
cursor: null,
searchQuery: null,
includeLinkedAudiences: null,
ids: null,
names: null,
sources: null,
statuses: null
})
};
fetch('https://api.example.com/api/public/tools/list_audiences', 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.example.com/api/public/tools/list_audiences",
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([
'limit' => null,
'cursor' => null,
'searchQuery' => null,
'includeLinkedAudiences' => null,
'ids' => null,
'names' => null,
'sources' => null,
'statuses' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/api/public/tools/list_audiences"
payload := strings.NewReader("{\n \"limit\": null,\n \"cursor\": null,\n \"searchQuery\": null,\n \"includeLinkedAudiences\": null,\n \"ids\": null,\n \"names\": null,\n \"sources\": null,\n \"statuses\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/api/public/tools/list_audiences")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": null,\n \"cursor\": null,\n \"searchQuery\": null,\n \"includeLinkedAudiences\": null,\n \"ids\": null,\n \"names\": null,\n \"sources\": null,\n \"statuses\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/tools/list_audiences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": null,\n \"cursor\": null,\n \"searchQuery\": null,\n \"includeLinkedAudiences\": null,\n \"ids\": null,\n \"names\": null,\n \"sources\": null,\n \"statuses\": null\n}"
response = http.request(request)
puts response.read_body{
"summary": "<string>",
"items": [
{
"id": "<string>",
"name": "<string>",
"source": "hubspot",
"contactsCount": 123,
"linkedFlowId": "<string>",
"sync": {
"status": "pending",
"lastStarted": "2023-11-07T05:31:56Z",
"lastCompleted": "2023-11-07T05:31:56Z",
"failStreak": 123,
"error": {
"message": "<string>",
"code": "<string>",
"details": "<string>"
}
},
"salesNavigatorImportStatus": "pending",
"lastModified": "2023-11-07T05:31:56Z",
"uiLinks": [
{
"label": "<string>",
"url": "<string>",
"reason": "<string>"
}
]
}
],
"cursor": "<string>",
"uiLinks": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}FirstTouch tools
List Audiences
Returns existing audiences that can be inspected or attached to a flow.
POST
/
api
/
public
/
tools
/
list_audiences
List Audiences
curl --request POST \
--url https://api.example.com/api/public/tools/list_audiences \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"limit": null,
"cursor": null,
"searchQuery": null,
"includeLinkedAudiences": null,
"ids": null,
"names": null,
"sources": null,
"statuses": null
}
'import requests
url = "https://api.example.com/api/public/tools/list_audiences"
payload = {
"limit": None,
"cursor": None,
"searchQuery": None,
"includeLinkedAudiences": None,
"ids": None,
"names": None,
"sources": None,
"statuses": None
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
limit: null,
cursor: null,
searchQuery: null,
includeLinkedAudiences: null,
ids: null,
names: null,
sources: null,
statuses: null
})
};
fetch('https://api.example.com/api/public/tools/list_audiences', 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.example.com/api/public/tools/list_audiences",
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([
'limit' => null,
'cursor' => null,
'searchQuery' => null,
'includeLinkedAudiences' => null,
'ids' => null,
'names' => null,
'sources' => null,
'statuses' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/api/public/tools/list_audiences"
payload := strings.NewReader("{\n \"limit\": null,\n \"cursor\": null,\n \"searchQuery\": null,\n \"includeLinkedAudiences\": null,\n \"ids\": null,\n \"names\": null,\n \"sources\": null,\n \"statuses\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.example.com/api/public/tools/list_audiences")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": null,\n \"cursor\": null,\n \"searchQuery\": null,\n \"includeLinkedAudiences\": null,\n \"ids\": null,\n \"names\": null,\n \"sources\": null,\n \"statuses\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/public/tools/list_audiences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": null,\n \"cursor\": null,\n \"searchQuery\": null,\n \"includeLinkedAudiences\": null,\n \"ids\": null,\n \"names\": null,\n \"sources\": null,\n \"statuses\": null\n}"
response = http.request(request)
puts response.read_body{
"summary": "<string>",
"items": [
{
"id": "<string>",
"name": "<string>",
"source": "hubspot",
"contactsCount": 123,
"linkedFlowId": "<string>",
"sync": {
"status": "pending",
"lastStarted": "2023-11-07T05:31:56Z",
"lastCompleted": "2023-11-07T05:31:56Z",
"failStreak": 123,
"error": {
"message": "<string>",
"code": "<string>",
"details": "<string>"
}
},
"salesNavigatorImportStatus": "pending",
"lastModified": "2023-11-07T05:31:56Z",
"uiLinks": [
{
"label": "<string>",
"url": "<string>",
"reason": "<string>"
}
]
}
],
"cursor": "<string>",
"uiLinks": [
"<unknown>"
]
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>"
}Authorizations
Body
application/json
Maximum audiences to return.
Cursor returned by a previous list_audiences call.
Search text for audience names.
When true, include audiences that are already linked to a flow. Defaults to false.
Optional audience ids to filter by. Use exact id values returned by list_audiences or create_audience.
Optional audience names to filter by.
Optional audience source filters.
Available options:
hubspot, csv, manual, system, sales_navigator, null Optional audience status filters.
Available options:
active, sync_in_progress, failed 
