Skip to main content

GET /profiles/:recipient_id

GEThttps://api.courier.com/profiles/:recipient_id
Returns the specified recipient Profile.
PATH PARAMS
recipient_idstringrequired
A unique identifier representing the recipient associated with the requested profile.
Responses
AUTH TOKEN
curl --request GET \
--url https://api.courier.com/profiles/0460766e-8463-4905-ae98-b72c7aef41d6 \
--header 'Accept: application/json'
Response Example
{
"profile": {
"email": "user@example.com",
"phone_number": "555-555-5555"
},
"preferences": {
"notifications": {
"{KEY}": {
"channel_preferences": [
{
"channel": "direct_message"
}
],
"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": "direct_message"
}
],
"rules": [
{
"type": "snooze",
"start": "2021-08-23T23:27:41+00:00",
"until": "2022-09-16T23:27:41+00:00"
}
],
"status": "OPTED_IN"
}
}
}
}

Example

Method: GET

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