---
title: "List all documents"
method: GET
path: "/documents"
tags: ["Documents"]
---

# List all documents

`GET /documents`

List all documents ordered by created_at descending.

## Query parameters

- `filter` object
  - `filename` object
    - `contains` string — Filter by string matching part of filename.
  - `customer_reference` object
    - `eq` string — Filter documents by a customer reference.
    - `in` string[] — Filter documents by a list of customer references.
  - `created_at` object
    - `gt` string, date-time — Filter by created at greater than provided value.
    - `lt` string, date-time — Filter by created at less than provided value.
- `sort` string[] — Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a `-` in front of the field name.
- `page[number]` integer
- `page[size]` integer

## Response `200`

Successful response

- object
  - `data` DocServiceDocument[]
    - `id` string, uuid — Identifies the resource.
    - `record_type` string — Identifies the type of the resource.
    - `created_at` string — ISO 8601 formatted date-time indicating when the resource was created.
    - `updated_at` string — ISO 8601 formatted date-time indicating when the resource was updated.
    - `content_type` string — The document's content_type.
    - `size` object — Indicates the document's filesize
      - `unit` string — Identifies the unit
      - `amount` integer — The number of bytes
    - `status` 'pending' | 'verified' | 'denied' — Indicates the current document reviewing status
    - `sha256` string — The document's SHA256 hash provided for optional verification purposes.
    - `filename` string — The filename of the document.
    - `customer_reference` string — Optional reference string for customer tracking.
    - `av_scan_status` 'scanned' | 'infected' | 'pending_scan' | 'not_scanned' — The antivirus scan status of the document.
  - `meta` PaginationMeta
    - `total_pages` integer, required
    - `total_results` integer
    - `page_number` integer, required
    - `page_size` integer

## Other responses

- `422` — Unprocessable entity. Check the 'detail' field in response for details.
- `default` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/revisions/e32d46c5945b/schema)
