---
title: "List Schemas"
method: GET
path: "/api/v1/database/schemas"
tags: ["Schemas"]
deprecated: true
---

# List Schemas

`GET /api/v1/database/schemas`

> **Deprecated.**

> **Warning**: This endpoint is deprecated. Please use the [List Resources](#tag/Resources/paths/~1resource~1catalog/get) endpoint instead with `filter={"operator":"exact","field":"type","value":"schema"}`.

## Query parameters

- `integration_id` string
- `parent_id` string
- `title` string

## Response `200`

List of schemas.

- object
  - `links` object — Indicates Links to associated pages.
    - `next` string — The link to the next page (null if there are no more pages).
    - `previous` string — The link to the previous page (null if on the first page).
  - `meta` object — Reprents the meta data of the response.
    - `page` integer — The current page number.
    - `previous_page` integer — The previous page number (null if on the first page).
    - `next_page` integer — The next page number (null if on the last page).
  - `count` integer — The total count of items returned.
  - `total_pages` integer — The total number of pages.
  - `results` V1SchemaResponse[]
    - `id` string — Unique identifier for the schema.
    - `created_at` string, date-time — The timestamp when the schema was created in Secoda.
    - `updated_at` string, date-time — The timestamp when the schema was last updated in Secoda.
    - `entity_type` string — The type of the schema.
    - `native_type` string — The native type of the schema as it's referred to in the integration.
    - `icon` string — An optional icon for the schema.
    - `title` string — The title of the schema.
    - `title_full` string — The full title of the schema, including its ancestry.
    - `title_cased` string — The title of the schema in title case format.
    - `description` string — Description of the schema.
    - `definition` string — The markdown documentation of the schema.
    - `definition_version` integer — Version number of the schema documentation.
    - `multiplayers` object[] — List of users interacting collaboratively on the schema [Not currently in use].
    - `multiplayer_last_modified_by` string — The last user to modify the schema [Not currently in use].
    - `multiplayer_last_modified` string — Timestamp of the last modification [Not currently in use].
    - `owners` string[] — List of User IDs associated with the schema.
    - `owners_groups` string[] — List of Group IDs associated with the schema.
    - `collections` string[] — List of Collection IDs to which the schema belongs.
    - `tags` string[] — List of Tag IDs associated with the schema.
    - `workspace_id` string — Workspace identifier in which the schema resides.
    - `published` boolean — Flag indicating whether the schema is published and visible to Viewers.
    - `archived` boolean — Flag indicating whether the schema is archived.
    - `archived_at` string, nullable — Timestamp when the schema was archived.
    - `pii` boolean — Flag indicating if the schema contains personally identifiable information.
    - `verified` boolean — Flag indicating whether the schema has been verified.
    - `url` string — URL to access the schema on the web.
    - `parent` string — Parent ID of the schema.
    - `children_count` integer — Number of child entities associated with this schema.
    - `bookmarked_by` string[] — List of User IDs who have bookmarked the schema.
    - `integration` string — Identifier for integration from which the schema was extracted.
    - `external_updated_at` string — The last update timestamp of the schema in the source.
    - `internal_usage` integer — Number of times the schema has been viewed within Secoda.
    - `internal_users` string[] — List of users who have interacted with the schema in Secoda.
    - `external_users` string[] — List of users who have interacted with the schema in the source.
    - `external_usage` integer — Number of times the schema has been viewed or queried in the Source.
    - `databuilder_id` string — Unique identifier for the schema.
    - `search_metadata` object — A set of properties used for indexing in search.
    - `sources` string[] — Data sources that augment the schema, such as dbt.
    - `subscribers` string[] — List of users subscribed to updates on the schema.
    - `teams` string[] — Teams IDs associated with the schema.
    - `stale` boolean — Flag indicating if the schema is considered stale.
    - `stale_at` string — Timestamp indicating when the schema was last marked as stale.
    - `forced_unstale_by_user` boolean — Flag indicating if the stale status of the schema was removed by a user action.
    - `current_user_permissions` string — Permissions of the current user on the schema.
    - `row_count` integer — The number of rows present in the schema.
    - `byte_size` integer — The size of the data used by the dashboard in bytes.
    - `display_metadata` object — Display-specific metadata for rendering the schema in Secoda.
    - `question_status` string — Status of the question [Not currently in use for Catalog resources].
    - `question_priority` string, nullable — Priority level of the question [Not currently in use for Catalog resources].
    - `question_answered_by` string, nullable — User ID of the person who answered the question [Not currently in use for Catalog resources].
    - `question_assigned_to` string, nullable — User ID of the person to whom the question is assigned [Not currently in use for Catalog resources].

## Other responses

- `400` — Bad request.
- `500` — Internal server error.

---

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