Skip to main content

GET /lists/:list_id

GEThttps://api.courier.com/lists/:list_id
Get the list items.
PATH PARAMS
list_idstringrequired
A unique identifier associated with the list you wish to retrieve.
Responses
AUTH TOKEN
curl --request GET \
--url https://api.courier.com/lists/example.list.id \
--header 'Accept: application/json'
Response Example
{
"created": "2020-06-10T18:41:29.093Z",
"id": "example.list.id",
"name": "Example List Name",
"updated": "2020-06-10T18:41:29.093Z",
"preferences": {
"notifications": {
"{KEY}": {
"channel_preferences": [
{
"channel": "direct_message"
}
],
"rules": [
{
"type": "snooze",
"start": "2021-08-23T23:27:41+00:00",
"until": "2022-09-16T23:27:41+00:00"
}
],
"status": "OPTED_IN"
}
},
"categories": {
"{KEY}": {
"channel_preferences": [
{
"channel": "direct_message"
}
],
"rules": [
{
"type": "snooze",
"start": "2021-08-23T23:27:41+00:00",
"until": "2022-09-16T23:27:41+00:00"
}
],
"status": "OPTED_IN"
}
}
}
}

Example

Method: GET

URL: https://api.courier.com/lists/abcdefgh12345678