Retrieve a paginated list of Subscriptions belonging to the account used to make the request.

GET /v1/Subscriptions

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

  • SinkSid string

    The SID of the sink that the list of Subscriptions should be filtered by.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DG[0-9a-fA-F]{32}$.

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • subscriptions array[object]
      Hide subscriptions attributes Show subscriptions attributes object
      • account_sid string | null

        The unique SID identifier of the Account.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • sid string | null

        A 34 character string that uniquely identifies this Subscription.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DF[0-9a-fA-F]{32}$.

      • date_created string(date-time) | null

        The date that this Subscription was created, given in ISO 8601 format.

      • date_updated string(date-time) | null

        The date that this Subscription was updated, given in ISO 8601 format.

      • description string | null

        A human readable description for the Subscription

      • sink_sid string | null

        The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DG[0-9a-fA-F]{32}$.

      • url string(uri) | null

        The URL of this resource.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Subscriptions
curl \
 --request GET 'https://events.twilio.com/v1/Subscriptions' \
 --user "username:password"
{
  "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
    }
  ]
}