API to fetch a paginated list of users or child objects subscribed to a given object.
curl --request GET \
--url https://hub.suprsend.com/v1/object/{object_type}/{id}/subscription/ \
--header 'Authorization: Bearer <token>'{
"meta": {
"count": 1,
"limit": 10,
"has_prev": true,
"before": "<string>",
"has_next": true,
"after": "<string>"
},
"results": [
{
"user": {
"distinct_id": "_distinct_id_",
"updated_at": "2025-04-04T09:55:12.422Z"
},
"object": {
"id": "frontend",
"object_type": "frontend",
"subscriptions_count": 123,
"updated_at": "2025-04-04T09:55:12.422Z"
},
"properties": {},
"created_at": "2025-04-04T09:55:12.397Z",
"updated_at": "2025-04-04T09:55:12.422Z"
}
]
}Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Unique identifier of the object in your system
Used to group similar objects together. Give plural namespace like teams, organizations, and roles.
200
Show child attributes
Total number of results.
1
Maximum number of results returned per request.
10
Indicates if there are previous results.
Cursor for the previous page, if applicable.
Indicates if there are more results.
Cursor for the next page, if applicable.
Show child attributes
Show child attributes
unique identifier of the object
"frontend"
type of object like teams, organizations, and roles. Used to group similar objects together.
"frontend"
number of users/child objects subscribed to this object
timestamp when subscription was first created
"2025-04-04T09:55:12.422Z"
object subscription properties, referred as $recipient.subscription.<key> in template or workflow.
"2025-04-04T09:55:12.397Z"
"2025-04-04T09:55:12.422Z"
Was this page helpful?
curl --request GET \
--url https://hub.suprsend.com/v1/object/{object_type}/{id}/subscription/ \
--header 'Authorization: Bearer <token>'{
"meta": {
"count": 1,
"limit": 10,
"has_prev": true,
"before": "<string>",
"has_next": true,
"after": "<string>"
},
"results": [
{
"user": {
"distinct_id": "_distinct_id_",
"updated_at": "2025-04-04T09:55:12.422Z"
},
"object": {
"id": "frontend",
"object_type": "frontend",
"subscriptions_count": 123,
"updated_at": "2025-04-04T09:55:12.422Z"
},
"properties": {},
"created_at": "2025-04-04T09:55:12.397Z",
"updated_at": "2025-04-04T09:55:12.422Z"
}
]
}