Skip to main content
GET
/
lists
/
{list_id}
/
subscriptions
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: 'My API Key',
});

const subscriptions = await client.lists.subscriptions.list('list_id');

console.log(subscriptions.items);
{
  "paging": {
    "cursor": "<string>",
    "more": true
  },
  "items": [
    {
      "recipientId": "<string>",
      "created": "<string>",
      "preferences": {
        "categories": {},
        "notifications": {}
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

list_id
string
required

A unique identifier representing the list you wish to retrieve.

Query Parameters

cursor
string | null

A unique identifier that allows for fetching the next set of list subscriptions

Response

paging
object
required
items
ListSubscriptionRecipient · object[]
required