Skip to main content

GET /lists/:list_id/subscriptions

GEThttps://api.courier.com/lists/:list_id/subscriptions
Get the list's subscriptions
PATH PARAMS
list_idstringrequired
A unique identifier associated with the list you wish to retrieve.
QUERY PARAMS
cursorstring
A unique identifier that allows for fetching the next set of list subscriptions
Responses
AUTH TOKEN
curl --request GET \
--url https://api.courier.com/lists/example.list.id/subscriptions?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA \
--header 'Accept: application/json'
Response Example
{
"paging": {
"cursor": "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA==",
"more": true
},
"items": [
{
"recipientId": "0460766e-8463-4905-ae98-b72c7aef41d6",
"created": "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/subscriptions