Pinnacle
API ReferenceAudiences

List Audiences

Serverhttps://api.pinnacle.sh/
POST
/audiences/list

Request body

Edit JSON, then apply it to your request.

JSON

List all audiences with optional filtering and pagination. Results are sorted by creation date, newest first.

Authorization

Pinnacle API key
PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pageIndexintegerOptional
Range
0 <= value
Default
0
pageSizeintegerOptional
Range
1 <= value <= 100
Default
20
namestringOptional

Filter audiences by name (partial match).

Example
"Acme Support"

Response Body

application/json

application/json

application/json

application/json

Get AudienceGET

Retrieve an audience by ID with optional pagination.

Remove Contacts from AudienceDELETE

Remove contacts from an existing audience. This operation is idempotent. - Only removes contacts that exist in the audience - Contacts not in the audience are ignored

Pinnacle referenceAsk Pinnacle

Get a sourced answer from the published documentation.

ViewingPinnacle documentation

Conversations are saved for analysis.

Try asking