---
title: "List Endpoints"
method: GET
path: "/endpoint"
tags: ["Endpoint"]
---

# List Endpoints

`GET /endpoint`

## Request

- Base URL: `https://api.sinay.ai/webhook/api/v1`
- URL: `https://api.sinay.ai/webhook/api/v1/endpoint`
- Auth: API key in header `API_KEY`

List the application's endpoints.

## 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`

- ListResponseEndpointOut
  - `data` EndpointOut[], required
    - `id` string, required: The ep's ID
    - `metadata` object, required: Optional additional properties for your endpoint.
    - `description` string, required: An example endpoint name
    - `rateLimit` integer, nullable: Rate limit of your endpoint in messages per second. This is an advanced field. Be aware that setting a low rateLimit can lead to a congestion queue and create delay in webhooks.
    - `uid` string, nullable: Optional unique identifier for the endpoint
    - `url` string, uri, required: Public url in your services where you plan to receive our webhooks. If you don't have a public url ready yet, you can use Svix play to test our webhooks https://www.svix.com/play/
    - `version` integer, required
    - `disabled` boolean: When disabled is true, no messages will be sent to your endpoint. This can be used to deactivate a development or a testing endpoint when not in use.
    - `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
  - `iterator` string, nullable
  - `prevIterator` string, nullable
  - `done` boolean, required

## Other responses

- `403`: Forbidden
- `404`: Not Found. No application found.
- `429`: Too Many Requests
- `500`: Internal Error

---

[API](https://skmtc.dev/safecube/apis/webhook-api.md) - [All operations](https://skmtc.dev/safecube/apis/webhook-api/llms.txt) - [OpenAPI document](https://skmtc.dev/safecube/apis/webhook-api/revisions/86d07c02c618?raw)
