Skip to main content

GET /profiles/:recipient_id/lists

URL: https://api.courier.com/profiles/:recipient_id/lists

Method: GET

Path Parameters

recipient_idstringrequired
A unique identifier representing the recipient associated with the requested profile.

Query Parameters

cursorstring
A unique identifier that allows for fetching the next set of list subscriptions

Responses

status: 200 OK

pagingobject
+ Show Properties
resultsarray
An array of lists
+ Show Properties

status: 400 Bad Request

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/profiles/0460766e-8463-4905-ae98-b72c7aef41d6/lists?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA \
--header 'Accept: application/json'

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