FUfullpath
audiences

Get a single audience

Retrieves an audience by id.

Additional fields can be included in the response using the embed parameter. Available embed options:

  • shoppers_count: Include the count of shoppers in the audience
get/dealerships/{dealershipId}/audiences/{id}

Request

Path parameters

dealershipIdinteger required

Dealership identifier (integer)

idinteger required

Audience identifier (integer)

Query parameters

embedstring

Comma-separated list of fields to embed in the response. Available options: shoppers_count

Response

The requested audience

idinteger required

Unique identifier for the audience

namestring required

Name of the audience

shopper_setstring required

Base64-encoded JSON filter definition for the shopper set

is_starred0 | 1 required

Whether the audience is starred (1) or not (0)

is_subscribed0 | 1 required

Whether the audience is subscribed (1) or not (0)

is_sales_enablement0 | 1 required

Whether the audience is used for sales enablement (1) or not (0)

is_data_enrichment0 | 1 required

Whether the audience is used for data enrichment (1) or not (0)

created_atstring date-time required

ISO 8601 timestamp when the audience was created

updated_bystring nullable

Name of the user who last updated the audience

updated_atstring date-time nullable required

ISO 8601 timestamp when the audience was last updated

public_urlstring uri required

Public URL for accessing the audience (contains authentication key)

shoppers_countinteger

Number of shoppers in the audience. Only included when embed=shoppers_count is specified.

Example response

{
  "id": 89,
  "name": "Commercial Vehicle Prospecting",
  "shopper_set": "eyJvciI6W3siYW5kIjpbeyJoYXNfbGVhZCI6eyJkYXRlIjp7ImZyb20iOiItNiBtb250aHMifSwidmVoaWNsZV9ib2R5X2NsYXNzIjoiQ2FyZ28gVmFuIn19XX1dfQ==",
  "created_at": "2026-01-08 19:02:22",
  "updated_by": "System User",
  "updated_at": "2026-01-08 19:02:22",
  "public_url": "https://example.com/api/v2/public/shoppers/saved-filters?key=example_key",
  "shoppers_count": 150
}

Changes

No recorded changes to this operation across all 1 revision of this API.