---
title: "List endpoints"
method: GET
path: "/workspaces/{ws_id}/endpoints"
tags: ["Endpoint"]
---

# List endpoints

`GET /workspaces/{ws_id}/endpoints`

## Query parameters

- `page_no` integer
- `page_size` integer
- `limit` integer
- `sort` 'id.desc' | 'id.asc'
- `after` string
- `before` string
- `name` string
- `enabled` boolean
- `created_at` union
  - object
    - `gt` integer
    - `gte` integer
    - `lt` integer
    - `lte` integer
  - integer
- `metadata` object

## Response `200`

OK

- union
  - object
    - `total` integer — Total number of resources.
    - `data` object[] — List of resources
      - `id` string
      - `name` string, nullable
      - `description` string, nullable
      - `enabled` boolean
      - `request` object
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
        - `headers` object, nullable
        - `timeout` integer
      - `retry` object
        - `strategy` 'fixed'
        - `config` object
          - `attempts` integer[]
      - `events` string[]
      - `metadata` Metadata
      - `rate_limit` RateLimit, nullable — The rate limit that uses GCRA algorithm (a variant of the leaky bucket algorithm that supports bursts).
        - `quota` integer, required — Rate limiting quota that allowed in every period.
        - `period` integer, required — Rate limiting period in seconds.
      - `created_at` integer
      - `updated_at` integer
  - object
    - `next` string, nullable — URI to next page when available.
    - `prev` string, nullable — URI to previous page when available.
    - `data` object[] — List of resources
      - `id` string
      - `name` string, nullable
      - `description` string, nullable
      - `enabled` boolean
      - `request` object
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
        - `headers` object, nullable
        - `timeout` integer
      - `retry` object
        - `strategy` 'fixed'
        - `config` object
          - `attempts` integer[]
      - `events` string[]
      - `metadata` Metadata
      - `rate_limit` RateLimit, nullable — The rate limit that uses GCRA algorithm (a variant of the leaky bucket algorithm that supports bursts).
        - `quota` integer, required — Rate limiting quota that allowed in every period.
        - `period` integer, required — Rate limiting period in seconds.
      - `created_at` integer
      - `updated_at` integer

---

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