USERS
EVENTS
OBJECTS
PREFERENCE
- Update User Preferences
- Get User Preferences
- Manage Tenant Preferences
- Update Object Preferences
- Get Object Preferences
LISTS
BROADCAST
List Object Subscriptions
Returns the list of subscribers in an object
curl --request GET \
--url https://hub.suprsend.com/v1/object/{object_type}/{id}/subscription/ \
--header 'Authorization: Bearer <token>'
{
"meta": {
"count": 3,
"limit": 10,
"has_prev": false,
"before": null,
"has_next": false,
"after": null
},
"results": [
{
"properties": {},
"user": null,
"object": {
"id": "devs",
"object_type": "teams",
"subscriptions_count": 1,
"updated_at": "2025-04-06T11:00:24.257046+00:00"
},
"created_at": "2025-04-06T11:00:24.260496+00:00",
"updated_at": "2025-04-06T11:00:24.260496+00:00"
},
{
"properties": {
"role": "employee"
},
"user": {
"distinct_id": "akhil.m@suprsend.com",
"updated_at": "2023-08-25T13:31:24.517819+00:00"
},
"object": null,
"created_at": "2024-11-10T21:40:02.169501+00:00",
"updated_at": "2024-11-10T21:40:02.169501+00:00"
}
]
}
Authorizations
Pass as Bearer <API_KEY>
. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
Unique identifier of the object in your system
Used to group similar objects together. Give plural namespace like teams, organizations, and roles.
Response
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.
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": 3,
"limit": 10,
"has_prev": false,
"before": null,
"has_next": false,
"after": null
},
"results": [
{
"properties": {},
"user": null,
"object": {
"id": "devs",
"object_type": "teams",
"subscriptions_count": 1,
"updated_at": "2025-04-06T11:00:24.257046+00:00"
},
"created_at": "2025-04-06T11:00:24.260496+00:00",
"updated_at": "2025-04-06T11:00:24.260496+00:00"
},
{
"properties": {
"role": "employee"
},
"user": {
"distinct_id": "akhil.m@suprsend.com",
"updated_at": "2023-08-25T13:31:24.517819+00:00"
},
"object": null,
"created_at": "2024-11-10T21:40:02.169501+00:00",
"updated_at": "2024-11-10T21:40:02.169501+00:00"
}
]
}