API to fetch all objects that a given user is subscribed to.
curl --request GET \
--url https://hub.suprsend.com/v1/user/{distinct_id}/subscribed_to/object/ \
--header 'Authorization: Bearer <token>'{
"meta": {
"count": 4,
"limit": 1,
"has_prev": false,
"before": null,
"has_next": false,
"after": null
},
"results": [
{
"properties": {
"role": "manager"
},
"object": {
"id": "frontend",
"object_type": "department",
"properties": {},
"subscriptions_count": 10,
"updated_at": "2025-01-28T16:49:23.695448+00:00"
},
"created_at": "2025-01-23T16:34:56.093683+00:00",
"updated_at": "2025-01-23T16:34:56.093683+00:00"
}
]
}Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Unique identifier of the user in your system
number of results to be returned in API response
200
Metadata related to pagination.
Show child attributes
Total number of results.
4
The maximum number of results per request.
10
Indicates if there are previous results.
false
Cursor for fetching previous results.
"01JXXXX99APxxxxxx8Wxxxx1B"
Indicates if there are more results available.
false
Cursor for fetching next results.
"02KXXXX99APxxxxxx0Wxxxx1A"
List of retrieved results.
Show child attributes
Object subscription property referred as $recipient.subscription.<prop> in templates or workflows.
Details of the subscribed object.
Show child attributes
Unique identifier for the object.
"frontend"
Type of object.
"department"
Additional properties related to the object.
Number of active subscriptions associated with the object.
1
Timestamp when the object was last updated.
"2025-01-28T16:49:23.695448+00:00"
Timestamp when the result was created.
"2025-01-23T16:34:56.093683+00:00"
Timestamp when the result was last updated.
"2025-01-23T16:34:56.093683+00:00"
Was this page helpful?
curl --request GET \
--url https://hub.suprsend.com/v1/user/{distinct_id}/subscribed_to/object/ \
--header 'Authorization: Bearer <token>'{
"meta": {
"count": 4,
"limit": 1,
"has_prev": false,
"before": null,
"has_next": false,
"after": null
},
"results": [
{
"properties": {
"role": "manager"
},
"object": {
"id": "frontend",
"object_type": "department",
"properties": {},
"subscriptions_count": 10,
"updated_at": "2025-01-28T16:49:23.695448+00:00"
},
"created_at": "2025-01-23T16:34:56.093683+00:00",
"updated_at": "2025-01-23T16:34:56.093683+00:00"
}
]
}