Surge home page
SupportDashboard
Surge
GET
/audiences/{audience_id}/contacts

List all contacts in an audience with cursor-based pagination. The account is inferred from the audience.

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

audience_id*string

The audience ID to list contacts for.

Query Parameters

after?string

Cursor for forward pagination. Use the next_cursor from a previous response.

before?string

Cursor for backward pagination. Use the previous_cursor from a previous response.

Response Body

application/json

application/json

import Surge from '@surgeapi/node';

const client = new Surge({
  apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const contact of client.audiences.listContacts('aud_01j9a43avnfqzbjfch6pygv1td')) {
  console.log(contact.id);
}
{
  "data": [
    {
      "email": "dom@toretto.family",
      "first_name": "Dominic",
      "id": "ctc_01j9dy8mdzfn3r0e8x1tbdrdrf",
      "last_name": "Toretto",
      "metadata": {
        "car": "1970 Dodge Charger R/T"
      },
      "phone_number": "+18015551234"
    }
  ],
  "pagination": {
    "next_cursor": null,
    "previous_cursor": null
  }
}
{
  "error": {
    "message": "The requested resource could not be found.",
    "type": "not_found"
  }
}