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

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

const subscriptionList = await client.lists.retrieve('list_id');

console.log(subscriptionList.id);
{
  "id": "example.list.id",
  "name": "Example List",
  "created": "2024-01-15T10:30:00.000Z",
  "updated": "2024-01-15T10:30:00.000Z"
}

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.

Response

​
id
string
required
​
name
string
required
​
created
string | null
​
updated
string | null