---
title: "list"
method: GET
path: "/v1/ingest/documents"
tags: ["Documents"]
---

# list

`GET /v1/ingest/documents`

lookup all documents across all resources which are currently on GroundX

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

## Query parameters

- `n` integer
- `filter` string
- `sort` 'name' | 'created' — The attribute to use to sort results
- `sortOrder` 'asc' | 'desc' — The order in which to sort results
- `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled'
- `nextToken` string

## Response `200`

Look up success

- DocumentListResponse
  - `documents` DocumentDetail[]
    - `bucketId` integer
    - `documentId` string, uuid, required — Unique system generated ID for the document
    - `fileName` string
    - `fileSize` string — The file size of the file stored in GroundX
    - `fileType` 'txt' | 'docx' | 'pptx' | 'xlsx' | 'pdf' | 'png' | 'jpg' | 'csv' | 'tsv' | 'json' — The type of document (one of the seven currently supported file types)
    - `processId` string, uuid — Unique system generated ID for the ingest request
    - `searchData` object
    - `sourceUrl` string, uri — Source document URL
    - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled'
    - `statusMessage` string
    - `xrayUrl` string, uri — Document X-Ray results
  - `nextToken` string

---

[API](https://skmtc.net/groundxai/apis/groundx-apis.md) · [All operations](https://skmtc.net/groundxai/apis/groundx-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/groundxai/groundx-apis/revisions/1c1a5c17f52f/schema)