Skip to main content

Get a profile

Returns the specified user profile.

URL: https://api.courier.com/profiles/:user_id

Method: GET

Path Parameters

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

Responses

status: 200 OK

profileobject
An object that includes any key-value pairs required by your chosen Integrations.
+ Show Properties
preferencesobject
+ Show Properties

status: 400 Bad Request

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.

Request Example

curl --request GET \
--url https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6 \
--header 'Accept: application/json'

Responses Example

{
"profile": {
"address": {},
"email": "user@example.com",
"phone_number": "555-555-5555",
"airship": {
"audience": {},
"device_types": [
null
]
},
"discord": {},
"expo": {},
"intercom": {
"to": {}
},
"ms_teams": {},
"slack": {},
"webhook": {
"authentication": {}
}
},
"preferences": {
"notifications": {
"{KEY}": {
"channel_preferences": [
{
"channel": "push"
}
],
"rules": [
{
"type": "snooze",
"start": "2021-08-23T23:27:41+00:00",
"until": "2022-09-16T23:27:41+00:00"
}
],
"status": "OPTED_IN"
}
},
"categories": {
"{KEY}": {
"channel_preferences": [
{
"channel": "push"
}
],
"rules": [
{
"type": "snooze",
"start": "2021-08-23T23:27:41+00:00",
"until": "2022-09-16T23:27:41+00:00"
}
],
"status": "OPTED_IN"
}
}
}
}
{
"message": "Error Message",
"type": "invalid_request_error"
}