Skip to main content

GET /lists/:list_id

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

Method: GET

Path Parameters

list_idstringrequired
A unique identifier associated with the list you wish to retrieve.

Responses

status: 200 OK

createdstring
The date/time of when the list was created. Represented as a string in ISO format.
idstring
List Identifier
namestring
List name
updatedstring
The date/time of when the list was updated. Represented as a string in ISO format.
preferencesobject
+ Show Properties

status: 404 Not Found

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.

Request Example

curl --request GET \
--url https://api.courier.com/lists/example.list.id \
--header 'Accept: application/json'

Responses 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": "push"
}
],
"rules": [
{
"type": "snooze"
}
],
"status": "OPTED_IN"
}
},
"categories": {
"{KEY}": {
"channel_preferences": [
{
"channel": "push"
}
],
"rules": [
{
"type": "snooze"
}
],
"status": "OPTED_IN"
}
}
}
}
{
"message": "Not Found",
"type": "invalid_request_error"
}