Get Audience API Reference

Serverhttps://api.pinnacle.sh/

Retrieve an audience by ID with optional pagination.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Query Parameters

idstring

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

Match

^aud_

Example

"aud_01J8K3R7M9"

pageintegerOptional

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

Range

1 <= value

Default

limitintegerOptional

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

Range

1 <= value <= 100

Default

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.audiences.get({
    id: "aud_abc123"
});

Responses

{  "id": "aud_abc123",  "name": "VIP Customers",  "description": "Our most valuable customers",  "contacts": [    {      "id": "co_def456",      "phoneNumber": "+12125551234",      "name": "John Doe",      "email": "john@example.com",      "tags": [        "vip",        "enterprise"      ],      "description": "Premium customer"    }  ],  "contactCount": 150,  "pagination": {    "page": 1,    "limit": 50,    "total": 150,    "hasMore": true  }}

Get Audience

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Paginated audience with contacts

Audience with no pagination

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`