Custom-audiences list
curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "<string>",
"name_contains": "<string>",
"targetable_only": false,
"with_deleted": false,
"limit": 100
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list"
payload = {
"account_id": "<string>",
"name_contains": "<string>",
"targetable_only": False,
"with_deleted": False,
"limit": 100
}
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({
account_id: '<string>',
name_contains: '<string>',
targetable_only: false,
with_deleted: false,
limit: 100
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list', 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.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list",
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([
'account_id' => '<string>',
'name_contains' => '<string>',
'targetable_only' => false,
'with_deleted' => false,
'limit' => 100
]),
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.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list"
payload := strings.NewReader("{\n \"account_id\": \"<string>\",\n \"name_contains\": \"<string>\",\n \"targetable_only\": false,\n \"with_deleted\": false,\n \"limit\": 100\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.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"<string>\",\n \"name_contains\": \"<string>\",\n \"targetable_only\": false,\n \"with_deleted\": false,\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list")
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 \"account_id\": \"<string>\",\n \"name_contains\": \"<string>\",\n \"targetable_only\": false,\n \"with_deleted\": false,\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_bodyX
Custom-audiences list
Custom audiences on the connected account (CRM lists, website / app / engagement audiences): size, whether targetable and why not (X needs ≥100 matched users active in 90 days), permission level, owner. Website audiences come from the X Pixel in Events Manager, not the API.
CLI: adside x custom-audiences list
POST
/
v1
/
workspaces
/
{workspaceId}
/
x
/
custom-audiences
/
list
Custom-audiences list
curl --request POST \
--url https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "<string>",
"name_contains": "<string>",
"targetable_only": false,
"with_deleted": false,
"limit": 100
}
'import requests
url = "https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list"
payload = {
"account_id": "<string>",
"name_contains": "<string>",
"targetable_only": False,
"with_deleted": False,
"limit": 100
}
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({
account_id: '<string>',
name_contains: '<string>',
targetable_only: false,
with_deleted: false,
limit: 100
})
};
fetch('https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list', 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.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list",
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([
'account_id' => '<string>',
'name_contains' => '<string>',
'targetable_only' => false,
'with_deleted' => false,
'limit' => 100
]),
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.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list"
payload := strings.NewReader("{\n \"account_id\": \"<string>\",\n \"name_contains\": \"<string>\",\n \"targetable_only\": false,\n \"with_deleted\": false,\n \"limit\": 100\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.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"<string>\",\n \"name_contains\": \"<string>\",\n \"targetable_only\": false,\n \"with_deleted\": false,\n \"limit\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adside.ai/v1/workspaces/{workspaceId}/x/custom-audiences/list")
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 \"account_id\": \"<string>\",\n \"name_contains\": \"<string>\",\n \"targetable_only\": false,\n \"with_deleted\": false,\n \"limit\": 100\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.
Path Parameters
Minimum string length:
1Body
application/json
X ads account id (e.g. 18ce55xcrlv). Omit it: it defaults to the ads account this workspace is connected to, and any other account is refused.
OWNER = audiences this account owns; SHARED = audiences shared into it.
Available options:
OWNER, SHARED Required range:
1 <= x <= 1000Response
200 - application/json
Success