| Action | Intended User | URI | Method | Request Params | Request Body | Response Body |
|---|
| 1 | subscribe to a topic | Synapse users who has READ permission on the object | /subscription | POST |
| Topic | Subscription |
| 2 | retrieve subscriptions a user has for a given list of topics | Synapse users | /subscription/list | POST |
| SubscriptionRequest | SubscriptionPagedResults |
| 3 | unsubscribe to a topic | Synapse users who created this subscription | /subscription/{subscriptionId} | DELETE |
|
|
|
| 4 | retrieve all subscriptions for a user | Synapse users | /subscription/all | GET | limit, offset, objectType (optional) |
| SubscriptionPagedResults |
| 5 | retrieve a subscription | Synapse users who created this subscription | /subscription/{subscriptionId} | GET |
|
| Subscription |
| 6 | retrieve subscribers for a topic | Synapse users | /subscription/subscribers | POST | limit, offsetnextPageToken | Topic | SubscriberPagedResults |
| 7 | retrieve number of subscribers for a topic | Synapse users | /subscription/subscribers/count | POST |
| Topic | SubscriberCount |
| 8 | subscribe to all topics with the same SubscriptionObjectType | Synapse users | /subscription/all | POST | objectType |
| Subscription |
