Get list subscriptions

GET

Returns the subscribed lists for a specified user.

Path parameters

user_idstringRequired

A unique identifier representing the user associated with the requested profile.

Query parameters

cursorstringOptional

A unique identifier that allows for fetching the next set of message statuses.

Response

This endpoint returns an object.

pagingobject

resultslist of objects

An array of lists

GET

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

200Retrieved

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

Built with

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

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