Skip to main content
GET
/
audiences
/
{audience_id}
/
contacts
JavaScript
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
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
audience_id
string
required

The audience ID to list contacts for.

Example:

"aud_01j9a43avnfqzbjfch6pygv1td"

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

List of contacts

A paginated list of contacts

​
data
Contact · object[]
required

The list of contacts

​
pagination
Pagination · object
required

Cursor-based pagination information

Example:
{
  "next_cursor": "g3QAAAABZAACaWRtAAAAGnBuXzAxamtzY2s5eDdkeW0wZnBxZjdjYmRyeQ==",
  "previous_cursor": null
}