Skip to main content
GET
Get audience

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Path Parameters

page_id
string
required

page_id parameter

audience_id
string
required

audience_id parameter

Response

Audience created successfully

actionFormIdOverride
string | null
required
actionFormInstructionsOverride
string | null
required
actionUrlOverride
string | null
required
archivedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
audienceId
string
required
computedName
string
required
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
customName
string | null
required
effectiveName
string
required
flags
enum<string>[]
required
Available options:
home_page
isNewPageAgent
boolean
required
latestVersion
object | null
required
pageId
string
required
personId
string | null
required
personRouteKey
string | null
required
publishedVersion
object | null
required
status
enum<string>
required
Available options:
archived,
cancelled,
draft,
pending,
processing,
published,
queued
supplementaryContext
string | null
required
effectiveMetadata
object
metadataOverride
object