Skip to main content

GET /lists

GEThttps://api.courier.com/lists
Get the list of lists
QUERY PARAMS
cursorstring
A unique identifier that allows for fetching the next set of lists.
patternstring
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.
Responses
AUTH TOKEN
curl --request GET \
--url https://api.courier.com/lists?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA%3D%3D&pattern=exact-list-id%20OR%20example.%2A%2C%20example.%2A%2A%2C%20example.%2A.list \
--header 'Accept: application/json'
Response Example
{
"paging": {
"cursor": "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA==",
"more": true
},
"results": [
{
"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"
}
],
"status": "OPTED_IN"
}
},
"categories": {
"{KEY}": {
"channel_preferences": [
{
"channel": "direct_message"
}
],
"rules": [
{
"type": "snooze"
}
],
"status": "OPTED_IN"
}
}
}
}
]
}