Appearance

Get Custom audiences ​

Endpoint ​

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

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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_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

Response Body ​

id
string

The unique identifier for the custom audience.

Supported in
  • Google Ads
  • LinkedIn
name
string

The name of the custom audience.

Supported in
  • Google Ads
  • LinkedIn
description
string

The description of the custom audience.

Supported in
  • Google Ads
  • LinkedIn
type
string

The type of custom audience.

Supported in
  • Google Ads
  • LinkedIn
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
account_id
string

The unique identifier for the account.

Supported in
  • Google Ads
  • LinkedIn
members
object[]

A list of audience members.

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
third_party_user_id
string
mobile_id
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.