Appearance

List Custom audiences ​

Endpoint ​

http
GET /unified/ads/custom_audiences
Integrations supported
  • Google Ads
  • LinkedIn
  • Meta Marketing API

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
account_id
string

The unique identifier for the account.

Required in
  • Google Ads
  • LinkedIn
  • Meta Marketing API

Response Body ​

result
object[]

List of Custom audiences

id
string

The unique identifier for the custom audience.

Supported in
  • Google Ads
  • LinkedIn
  • Meta Marketing API
name
string

The name of the custom audience.

Supported in
  • Google Ads
  • LinkedIn
  • Meta Marketing API
description
string

The description of the custom audience.

Supported in
  • Google Ads
  • LinkedIn
  • Meta Marketing API
type
string

The type of custom audience.

Supported in
  • Google Ads
  • LinkedIn
  • Meta Marketing API
source
string

The source of custom audience.

Supported in
  • LinkedIn
status
string

The status of the custom audience.

All possible enum values:
  • active
  • inactive
  • archived
  • deleted
  • with_issues
  • in_progress
  • failed
  • expired
Supported in
  • Google Ads
  • LinkedIn
  • Meta Marketing API
account_id
string

The unique identifier for the account.

Supported in
  • LinkedIn
members
object[]

A list of audience members.

Supported in
  • Google Ads
first_name
string
last_name
string
title
string
company
string
country
string
url
string
keyword
string
email
string
phone
string
application
string
location_category
string
google_advertiser_id
string
website
string
domain
string
organization_urn
string
linkedin_url
string
created_at
string · date-time

The date and time the account was created.

Supported in
  • LinkedIn
updated_at
string · date-time

The date and time the account was last updated.

Supported in
  • LinkedIn
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.