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

# List sources

`GET /workspaces/{ws_id}/sources`

## 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
      - `enabled` boolean
      - `type` 'http'
      - `config` object, required
        - `http` HTTPSourceConfig, required
          - `path` string
          - `methods` string[]
          - `response` object, nullable
            - `code` integer, required
            - `content_type` string, required
            - `body` string
      - `async` boolean — Whether to ingest events asynchronously through the queue
      - `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
      - `enabled` boolean
      - `type` 'http'
      - `config` object, required
        - `http` HTTPSourceConfig, required
          - `path` string
          - `methods` string[]
          - `response` object, nullable
            - `code` integer, required
            - `content_type` string, required
            - `body` string
      - `async` boolean — Whether to ingest events asynchronously through the queue
      - `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)