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.

  • PageSize integer

    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.

Responses

  • • 200

    OK

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

        Account SID.

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

      • date_created string(date-time) | null

        The date this Subscription was created

      • date_updated string(date-time) | null

        The date this Subscription was updated

      • description string | null

        Subscription description

      • links object(uri-map) | null

        Nested resource URLs.

      • sid string | null

        A 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}$.

      • sink_sid string | null

        Sink SID.

        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.
GET /v1/Subscriptions 
curl \
 -X GET https://events.twilio.com/v1/Subscriptions \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "subscriptions": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "description": "string",
      "links": {},
      "sid": "string",
      "sink_sid": "string",
      "url": "https://example.com"
    }
  ]
}