Retrieve a paginated list of Subscriptions belonging to the account used to make the request.
Subscription to send Event Types to a Sink
Retrieve a paginated list of Subscriptions belonging to the account used to make the request.
Query parameters
-
The SID of the sink that the list of Subscriptions should be filtered by.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^DG[0-9a-fA-F]{32}$
. -
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Minimum value is
1
, maximum value is1000
. -
The page index. This value is simply for client state.
Minimum value is
0
. -
The page token. This is provided by the API.
GET
/v1/Subscriptions
curl \
--request GET 'https://events.twilio.com/v1/Subscriptions' \
--user "username:password"
Response examples (200)
Read empty
{
"meta": {
"key": "subscriptions",
"url": "https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0",
"page": 0,
"page_size": 10,
"next_page_url": null,
"first_page_url": "https://events.twilio.com/v1/Subscriptions?PageSize=10&Page=0",
"previous_page_url": null
},
"subscriptions": []
}
{
"meta": {
"key": "subscriptions",
"url": "https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0",
"page": 0,
"page_size": 20,
"next_page_url": null,
"first_page_url": "https://events.twilio.com/v1/Subscriptions?PageSize=20&Page=0",
"previous_page_url": null
},
"subscriptions": [
{
"sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"links": {
"subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents"
},
"sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"description": "A subscription",
"date_created": "2015-07-30T20:00:00Z",
"date_updated": "2015-07-30T20:01:33Z",
"receive_events_from_subaccounts": false
},
{
"sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
"url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
"links": {
"subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents"
},
"sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"description": "Another subscription",
"date_created": "2015-07-30T20:00:00Z",
"date_updated": "2015-07-30T20:01:33Z",
"receive_events_from_subaccounts": false
}
]
}
{
"meta": {
"key": "subscriptions",
"url": "https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0",
"page": 0,
"page_size": 10,
"next_page_url": null,
"first_page_url": "https://events.twilio.com/v1/Subscriptions?SinkSid=DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=10&Page=0",
"previous_page_url": null
},
"subscriptions": [
{
"sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"links": {
"subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedEvents"
},
"sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"description": "A subscription",
"date_created": "2015-07-30T20:00:00Z",
"date_updated": "2015-07-30T20:01:33Z",
"receive_events_from_subaccounts": false
},
{
"sid": "DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
"url": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
"links": {
"subscribed_events": "https://events.twilio.com/v1/Subscriptions/DFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/SubscribedEvents"
},
"sink_sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"description": "Another subscription",
"date_created": "2015-07-30T20:00:00Z",
"date_updated": "2015-07-30T20:01:33Z",
"receive_events_from_subaccounts": false
}
]
}