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

GET /v1/Sinks

Sink destination to send events to

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

Query parameters

  • InUse boolean

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

  • Status string

    A String query parameter filtering the results by status initialized, validating, active or failed.

  • 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 object
    • sinks array[object]
      Hide sinks attributes Show sinks attributes array[object]
      • date_created string(date-time) | null

        The date this Sink was created

      • date_updated string(date-time) | null

        The date this Sink was updated

      • description string | null

        Sink Description

      • links object(uri-map) | null

        Nested resource URLs.

      • sid string | null

        A string that uniquely identifies this Sink.

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

      • sink_configuration

        JSON Sink configuration.

      • sink_type string | null

        Sink type.

        Values are kinesis, webhook, or segment.

      • status string | null

        The Status of this Sink

        Values are initialized, validating, active, or failed.

      • url string(uri) | null

        The URL of this resource.
GET /v1/Sinks 
curl \
 -X GET https://events.twilio.com/v1/Sinks \
 --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"
  },
  "sinks": [
    {
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "description": "string",
      "links": {},
      "sid": "string",
      "sink_type": "kinesis",
      "status": "initialized",
      "url": "https://example.com"
    }
  ]
}
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"
  },
  "sinks": [
    {
      "date_created": "2024-05-04T09:42:00+00:00",
      "date_updated": "2024-05-04T09:42:00+00:00",
      "description": "string",
      "links": {},
      "sid": "string",
      "sink_type": "kinesis",
      "status": "initialized",
      "url": "https://example.com"
    }
  ]
}