---
title: "List Data Sources"
method: GET
path: "/api/v1/data_sources/"
tags: ["data_sources"]
---

# List Data Sources

`GET /api/v1/data_sources/`

Fetch metadata about all data sources, not including their text.

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` DataSourceProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'name' | 'description' | 'labels' | 'chunk' | 'chunk_delimiter' | 'updated_at' | 'last_updated_by' — Names of data source fields supported for filtering/sorting on list endpoint.
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` DataSourceProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseDataSourceMetadataResponse
  - `items` DataSourceMetadataResponse[], required — List of items returned from the query
    - `name` string, required — The data source name. Must be unique within suborg. Cannot contain whitespace.
    - `description` string, nullable — The description of the data source.
    - `labels` string[] — Searchable labels for the data source. Can be included in agent.prompt_tool_defaults for a given tool to give the agent access to data sources with those labels when calling that tool.
    - `chunk` boolean, required — Whether the content should be split into smaller chunks. (This feature is coming in the future - currently this value will always be treated as False.)
    - `chunk_delimiter` string, nullable — String that should be treated as delimiter between intended chunks. (This feature is coming in the future - currently this value will always be treated as None.)
    - `id` integer, required — The data source ID.
    - `edit_comments` string, nullable — The comments for the most recent edit to the data source
    - `updated_at` string, date-time, required — Timestamp of most recent update
    - `last_updated_by` string, nullable, required — Email of the user who last updated the data source
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

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