---
title: "List Documents"
method: GET
path: "/api/v1/document"
tags: ["Documents"]
---

# List Documents

`GET /api/v1/document`

This endpoint allows you to retrieve a list of documents. You can optionally filter the documents by title using the "title" query parameter.

## Query parameters

- `title` string

## Response `200`

List of documents.

- 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` V1DocumentResponse[]
    - `id` string — The unique identifier of the resource.
    - `created_at` string, date-time — The timestamp when the resource was created in Secoda in UTC format.
    - `updated_at` string, date-time — The timestamp when the resource was last updated in Secoda in UTC format.
    - `entity_type` string — The type of resource in Secoda.
    - `native_type` string — The native type of the resource as it is referred to in the integration.
    - `bookmarked_by` string[] — List of member IDs that have bookmarked the resource.
    - `icon` string — The icon associated with the resource.
    - `title` string — The title of the resource.
    - `title_full` string — The full title of the resource, including its ancestry.
    - `title_cased` string — The title in a cased format.
    - `description` string — A description of the resource.
    - `definition` string, markdown — The documentation of the resource, written in Mark Down format.
    - `definition_version` integer — The version of the resource's documentation.
    - `multiplayers` string[] — List of members who have opened or worked with the resource recently.
    - `multiplayer_last_modified_by` string — The last member who modified this resource.
    - `multiplayer_last_modified` string, date-time — The timestamp when the multiplayer was last modified in UTC format.
    - `owners` string[] — List of owner IDs for the resource.
    - `owners_groups` string[] — List of owner group IDs for the resource.
    - `collections` string[] — List of IDs representing the collection(s) that the resource has been added to.
    - `tags` string[] — List of tag IDs added to the resource.
    - `workspace_id` string — The ID of the workspace.
    - `total_usage` integer — The total usage count for the resource.
    - `published` boolean — Indicates if the resource is published and can be seen by Viewers.
    - `archived` boolean — Indicates if the resource is deleted.
    - `pii` boolean — Indicates if the resource contains Personally Identifiable Information (PII). Values can be - <ul> <li> True <li> False</ul>
    - `verified` boolean — Indicates if the resource is verified. Values can be - <ul><li> True <li> False</ul>
    - `url` string — The URL associated with the resource.
    - `parent` string — The parent resource's ID.
    - `children_count` integer — The count of children entities of the resource.
    - `integration` string — The integration ID associated with the resource.
    - `external_updated_at` string, date-time — The timestamp of the last update for the resource in the source.
    - `internal_usage` integer — The internal usage count for the resource.
    - `internal_users` string[] — List of internal user IDs for the resource.
    - `external_users` string[] — List of external user IDs for the resource extracted from the integration.
    - `external_usage` integer — The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource.
    - `databuilder_id` string — The databuilder ID associated with the resource. This is a generated field.
    - `search_metadata` object — Metadata related to indexing the resource for optimizing search.
    - `sources` string[] — List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT.
    - `subscribers` string[] — List of User IDs who subscribe to the resource.
    - `teams` string[] — List of team IDs associated with the resource.
    - `stale` boolean — Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction.
    - `current_user_permissions` object — Permissions of the current user for this resource.
      - `read` boolean
      - `write` boolean
      - `execute` boolean
    - `parent_id` string — Indicates the UUID of the parent of the document, which is always another document.
    - `base_entity_id` string — Indicates the UUID of the highest level ancestor of the document.

## 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)