---
title: "List Sinks"
method: GET
path: "/api/v1/app/{app_id}/sink"
tags: ["Endpoint"]
---

# List Sinks

`GET /api/v1/app/{app_id}/sink`

List the application's sinks.

## Path parameters

- `app_id` string, required — The Application's ID or UID.

## Query parameters

- `limit` integer — Limit the number of returned items
- `iterator` string, nullable — The iterator returned from a prior invocation
- `order` 'ascending' | 'descending' — Defines the ordering in a listing of results.

## Response `200`

- ListResponseSinkOut
  - `data` SinkOut[], required
    - union
      - object
        - `id` string, required — The Endpoint's ID.
        - `metadata` object, required
        - `description` string, required
        - `rateLimit` integer, nullable — Deprecated, use `throttleRate` instead.
        - `throttleRate` integer, nullable — Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.
        - `uid` string, nullable — Optional unique identifier for the endpoint.
        - `disabled` boolean
        - `filterTypes` string[], nullable
        - `channels` string[], nullable — List of message channels this endpoint listens to (omit for all).
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `type` 'http', required
        - `url` string, uri, required
      - object
        - `id` string, required — The Endpoint's ID.
        - `metadata` object, required
        - `description` string, required
        - `rateLimit` integer, nullable — Deprecated, use `throttleRate` instead.
        - `throttleRate` integer, nullable — Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.
        - `uid` string, nullable — Optional unique identifier for the endpoint.
        - `disabled` boolean
        - `filterTypes` string[], nullable
        - `channels` string[], nullable — List of message channels this endpoint listens to (omit for all).
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `type` 'eventStream', required
      - object
        - `id` string, required — The Endpoint's ID.
        - `metadata` object, required
        - `description` string, required
        - `rateLimit` integer, nullable — Deprecated, use `throttleRate` instead.
        - `throttleRate` integer, nullable — Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.
        - `uid` string, nullable — Optional unique identifier for the endpoint.
        - `disabled` boolean
        - `filterTypes` string[], nullable
        - `channels` string[], nullable — List of message channels this endpoint listens to (omit for all).
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `type` 'autoConfig', required
  - `iterator` string, nullable, required
  - `prevIterator` string, nullable
  - `done` boolean, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Validation Error
- `429` — Too Many Requests

---

[API](https://skmtc.net/svix/apis/svix-api.md) · [All operations](https://skmtc.net/svix/apis/svix-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/svix/svix-api/versions/16dbcc056c48/schema)