Get the subscriptions for a list

GET

Get the list’s subscriptions.

Path parameters

list_idstringRequired

A unique identifier representing the list you wish to retrieve.

Query parameters

cursorstringOptional

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

Response

This endpoint returns an object.

pagingobject

itemslist of objects

GET

1 curl -G https://api.courier.com/lists/:list_id/subscriptions \
2      -H "Authorization: Bearer <authorizationToken>" \
3      -d cursor=string

200Retrieved

1 {
2   "paging": {
3     "more": true,
4     "cursor": "string"
5   },
6   "items": [
7     {
8       "recipientId": "string",
9       "created": "string",
10       "preferences": {
11         "categories": {
12           "string": {
13             "status": "OPTED_IN",
14             "rules": [
15               {
16                 "until": "string",
17                 "start": "string"
18               }
19             ],
20             "channel_preferences": [
21               {
22                 "channel": "direct_message"
23               }
24             ]
25           }
26         },
27         "notifications": {
28           "string": {
29             "status": "OPTED_IN",
30             "rules": [
31               {
32                 "until": "string",
33                 "start": "string"
34               }
35             ],
36             "channel_preferences": [
37               {
38                 "channel": "direct_message"
39               }
40             ]
41           }
42         }
43       }
44     }
45   ]
46 }

Built with

1	curl -G https://api.courier.com/lists/:list_id/subscriptions \
2	-H "Authorization: Bearer <authorizationToken>" \
3	-d cursor=string

1	{
2	"paging": {
3	"more": true,
4	"cursor": "string"
5	},
6	"items": [
7	{
8	"recipientId": "string",
9	"created": "string",
10	"preferences": {
11	"categories": {
12	"string": {
13	"status": "OPTED_IN",
14	"rules": [
15	{
16	"until": "string",
17	"start": "string"
18	}
19	],
20	"channel_preferences": [
21	{
22	"channel": "direct_message"
23	}
24	]
25	}
26	},
27	"notifications": {
28	"string": {
29	"status": "OPTED_IN",
30	"rules": [
31	{
32	"until": "string",
33	"start": "string"
34	}
35	],
36	"channel_preferences": [
37	{
38	"channel": "direct_message"
39	}
40	]
41	}
42	}
43	}
44	}
45	]
46	}