Get a profile

GET

Returns the specified user profile.

Path parameters

user_idstringRequired

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

Response

This endpoint returns an object.

profilemap from strings to any

preferencesobjectOptional

GET

1 curl https://api.courier.com/profiles/:user_id \
2      -H "Authorization: Bearer <authorizationToken>"

200Retrieved

1 {
2   "profile": {
3     "string": {}
4   },
5   "preferences": {
6     "categories": {
7       "string": {
8         "status": "OPTED_IN",
9         "rules": [
10           {
11             "until": "string",
12             "start": "string"
13           }
14         ],
15         "channel_preferences": [
16           {
17             "channel": "direct_message"
18           }
19         ]
20       }
21     },
22     "notifications": {
23       "string": {
24         "status": "OPTED_IN",
25         "rules": [
26           {
27             "until": "string",
28             "start": "string"
29           }
30         ],
31         "channel_preferences": [
32           {
33             "channel": "direct_message"
34           }
35         ]
36       }
37     }
38   }
39 }

Built with

1	curl https://api.courier.com/profiles/:user_id \
2	-H "Authorization: Bearer <authorizationToken>"

1	{
2	"profile": {
3	"string": {}
4	},
5	"preferences": {
6	"categories": {
7	"string": {
8	"status": "OPTED_IN",
9	"rules": [
10	{
11	"until": "string",
12	"start": "string"
13	}
14	],
15	"channel_preferences": [
16	{
17	"channel": "direct_message"
18	}
19	]
20	}
21	},
22	"notifications": {
23	"string": {
24	"status": "OPTED_IN",
25	"rules": [
26	{
27	"until": "string",
28	"start": "string"
29	}
30	],
31	"channel_preferences": [
32	{
33	"channel": "direct_message"
34	}
35	]
36	}
37	}
38	}
39	}