Audience

Queries the audiences visible to the caller: owned, shared with them, or both.

Owned includes every public audience. Rows the caller reaches through a share are flagged with isShared, which is independent of isPublic — a row can be both.

get/audiences

Query parameters

scope'Owned' | 'Shared' | 'All'

Which audiences a query over audiences should return, relative to the caller.

Which audiences to return: owned by the caller's organization, shared with the caller, or both.

pageinteger

The 1-based page index.

page_sizeinteger

The number of items per page.

sortstring[]

Sort fields. Prefix with - for descending order (e.g. -created_at).

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by name.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by status.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by is_public.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by is_distilling.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by owner_mail.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by created_at.

logic'and' | 'or'

How to combine the field filters: "and" (default) requires every filter to match, "or" requires any of them to match.

Response

OK

totalinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger

Changes