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

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

const lists = await client.lists.list();

console.log(lists.items);
{
  "paging": {
    "cursor": "<string>",
    "more": true
  },
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "created": "<string>",
      "updated": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
cursor
string | null

A unique identifier that allows for fetching the next page of lists.

​
pattern
string | null

"A pattern used to filter the list items returned. Pattern types supported: exact match on list_id or a pattern of one or more pattern parts. you may replace a part with either: * to match all parts in that position, or ** to signify a wildcard endsWith pattern match."

Response

​
paging
object
required
​
items
SubscriptionList · object[]
required