Get Audience | Pinnacle | Documentation

1 import { PinnacleClient } from "rcs-js"; 2 3 async function main() { 4 const client = new PinnacleClient({ 5 environment: "https://api.pinnacle.sh", 6 }); 7 await client.audiences.get({ 8 id: "aud_abc123", 9 page: 1, 10 limit: 50, 11 }); 12 } 13 main();

1 { 2 "id": "aud_abc123", 3 "name": "VIP Customers", 4 "description": "Our most valuable customers", 5 "contacts": [ 6 { 7 "description": "Premium customer", 8 "email": "john@example.com", 9 "id": "co_def456", 10 "name": "John Doe", 11 "phoneNumber": "+12125551234", 12 "tags": [ 13 "vip", 14 "enterprise" 15 ] 16 } 17 ], 18 "contactCount": 150, 19 "pagination": { 20 "page": 1, 21 "limit": 50, 22 "total": 150, 23 "hasMore": true 24 } 25 }

Retrieve an audience by ID with optional pagination.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Query parameters

idstringRequiredformat: "^aud_"

Audience ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.

pageintegerOptional>=1Defaults to 1

Page number. If provided with or without limit, returns paginated contacts.

limitintegerOptional1-100Defaults to 50

Items per page. If provided with or without page, returns paginated contacts.

Response

Successfully retrieved audience.

Count Onlyobject

Returned when no pagination parameters are provided.

Authentication

Query parameters

Response

Errors