Get users

GET

Get Bulk Job Users

Path parameters

job_idstringRequired

A unique identifier representing the bulk job

Response

This endpoint returns an object.

itemslist of objects

pagingobject

GET

1 curl https://api.courier.com/bulk/:job_id/users \
2      -H "Authorization: Bearer <authorizationToken>"

200Retrieved

1 {
2   "items": [
3     {
4       "status": "PENDING",
5       "data": {},
6       "messageId": "string",
7       "preferences": {
8         "categories": {
9           "string": {
10             "status": "OPTED_IN",
11             "rules": [
12               {
13                 "until": "string",
14                 "start": "string"
15               }
16             ],
17             "channel_preferences": [
18               {
19                 "channel": "direct_message"
20               }
21             ]
22           }
23         },
24         "notifications": {
25           "string": {
26             "status": "OPTED_IN",
27             "rules": [
28               {
29                 "until": "string",
30                 "start": "string"
31               }
32             ],
33             "channel_preferences": [
34               {
35                 "channel": "direct_message"
36               }
37             ]
38           }
39         }
40       },
41       "profile": {},
42       "recipient": "string",
43       "to": {
44         "context": {
45           "tenant_id": "string"
46         },
47         "data": {
48           "string": {}
49         },
50         "email": "string",
51         "locale": "string",
52         "user_id": "string",
53         "phone_number": "string",
54         "preferences": {
55           "notifications": {
56             "string": {
57               "status": "OPTED_IN",
58               "rules": [
59                 {
60                   "until": "string",
61                   "start": "string"
62                 }
63               ],
64               "channel_preferences": [
65                 {
66                   "channel": "direct_message"
67                 }
68               ],
69               "source": "subscription"
70             }
71           },
72           "categories": {
73             "string": {
74               "status": "OPTED_IN",
75               "rules": [
76                 {
77                   "until": "string",
78                   "start": "string"
79                 }
80               ],
81               "channel_preferences": [
82                 {
83                   "channel": "direct_message"
84                 }
85               ],
86               "source": "subscription"
87             }
88           },
89           "templateId": "string"
90         },
91         "tenant_id": "string",
92         "account_id": "string"
93       }
94     }
95   ],
96   "paging": {
97     "more": true,
98     "cursor": "string"
99   }
100 }

Built with

1	curl https://api.courier.com/bulk/:job_id/users \
2	-H "Authorization: Bearer <authorizationToken>"

1	{
2	"items": [
3	{
4	"status": "PENDING",
5	"data": {},
6	"messageId": "string",
7	"preferences": {
8	"categories": {
9	"string": {
10	"status": "OPTED_IN",
11	"rules": [
12	{
13	"until": "string",
14	"start": "string"
15	}
16	],
17	"channel_preferences": [
18	{
19	"channel": "direct_message"
20	}
21	]
22	}
23	},
24	"notifications": {
25	"string": {
26	"status": "OPTED_IN",
27	"rules": [
28	{
29	"until": "string",
30	"start": "string"
31	}
32	],
33	"channel_preferences": [
34	{
35	"channel": "direct_message"
36	}
37	]
38	}
39	}
40	},
41	"profile": {},
42	"recipient": "string",
43	"to": {
44	"context": {
45	"tenant_id": "string"
46	},
47	"data": {
48	"string": {}
49	},
50	"email": "string",
51	"locale": "string",
52	"user_id": "string",
53	"phone_number": "string",
54	"preferences": {
55	"notifications": {
56	"string": {
57	"status": "OPTED_IN",
58	"rules": [
59	{
60	"until": "string",
61	"start": "string"
62	}
63	],
64	"channel_preferences": [
65	{
66	"channel": "direct_message"
67	}
68	],
69	"source": "subscription"
70	}
71	},
72	"categories": {
73	"string": {
74	"status": "OPTED_IN",
75	"rules": [
76	{
77	"until": "string",
78	"start": "string"
79	}
80	],
81	"channel_preferences": [
82	{
83	"channel": "direct_message"
84	}
85	],
86	"source": "subscription"
87	}
88	},
89	"templateId": "string"
90	},
91	"tenant_id": "string",
92	"account_id": "string"
93	}
94	}
95	],
96	"paging": {
97	"more": true,
98	"cursor": "string"
99	}
100	}