Skip to main content

GET /profiles/:recipient_id/lists

GEThttps://api.courier.com/profiles/:recipient_id/lists
Returns the subscribed lists for a specified recipient Profile.
PATH PARAMS
recipient_idstringrequired
A unique identifier representing the recipient associated with the requested profile.
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/profiles/0460766e-8463-4905-ae98-b72c7aef41d6/lists?cursor=MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA \
--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"
}
}
}
}
]
}

Example

Method: GET

URL: https://api.courier.com/profiles/abcdefgh12345678/lists?cursor=12345678abcdefgh