---
title: "List Sources Route"
method: GET
path: "/api/knowledge_bases/{knowledge_base_id}/sources/"
tags: ["source"]
---

# List Sources Route

`GET /api/knowledge_bases/{knowledge_base_id}/sources/`

Get all sources for a knowledge base.

## Path parameters

- `knowledge_base_id` string, uuid, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- Source[]
  - `name` string, required
  - `knowledge_base_id` string, uuid, required
  - `description` string, required
  - `source_params` union, required
    - WebV0Params — Parameters for web v0 sources.
      - `name` 'web_v0'
      - `urls` string[], required
      - `include_regex` string, nullable
      - `exclude_regex` string, nullable
      - `max_depth` integer
      - `limit` integer
      - `allow_backward_links` boolean
      - `allow_external_links` boolean
      - `scrape_options` WebV0ScrapeOptions — Web v0 scrape options.
        - `wait_for` integer — Amount of time (in milliseconds) to wait for each page to load before scraping content.
    - NotionV0Params — Parameters for Notion sources.
      - `name` 'notion_v0'
      - `integration_id` string, uuid, required
      - `limit` integer, nullable
    - S3PublicV0Params — Parameters for S3 public sources.
      - `name` 's3_public_v0'
      - `bucket_name` string, required
      - `prefix` string, required
      - `limit` integer, required
    - S3PrivateV0Params — Parameters for S3 private sources.
      - `name` 's3_private_v0'
      - `integration_id` string, uuid, required
      - `bucket_name` string, required
      - `prefix` string, required
      - `limit` integer, required
  - `source_schedule` SourceSchedule, required — Source schedule model.
    - `cron` string, required
    - `utc_offset` integer, required
  - `id` string, uuid, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `deleted_at` string, date-time, nullable, required
  - `status` 'pending' | 'syncing' | 'synced' | 'failed', required — Source status enum.

## Other responses

- `422` — Validation Error

## Changes

- **2024-12-03** `c3d745f0888a` — 1 breaking, 3 info
  - added `#/components/schemas/NotionV0Params` to the `items/source_params` response property `oneOf` list for the response status `200`
  - added `notion_v0` discriminator mapping keys to the `items/source_params` response property for the response status `200`
  - removed `notion` discriminator mapping keys from the `items/source_params` response property for the response status `200`
  - removed `#/components/schemas/NotionParams` from the `items/source_params` response property `oneOf` list for the response status `200`
- **2024-11-20** `d630ad236884` — 1 info
  - the `wait_for` response's property default value changed from `1000` to `3000` for the status `200`
- **2024-11-15** `357b7ce8fa38` — 1 info
  - added the optional property `items/source_params/oneOf[subschema #1: WebV0Params]/scrape_options` to the response with the `200` status
- **2024-11-04** `4abd340ba528` — 1 breaking, 1 info
  - added `#/components/schemas/S3PrivateV0Params` to the `items/source_params` response property `oneOf` list for the response status `200`
  - added `s3_private_v0` discriminator mapping keys to the `items/source_params` response property for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/cleanlab/apis/agility/changes/api/knowledge_bases/:knowledge_base_id/sources/get.md)

---

[API](https://skmtc.dev/cleanlab/apis/agility.md) · [All operations](https://skmtc.dev/cleanlab/apis/agility/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cleanlab/agility/revisions/c3d745f0888a/schema)