Skip to main content
GET
/
v1
/
documents
List all documents
curl --request GET \
  --url http://localhost:8000/v1/documents \
  --header 'Authorization: Bearer <token>'
{
  "documents": [
    {
      "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vault_uri": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "file_size_bytes": 123,
      "page_count": 123,
      "latest_job_status": "pending"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
per_page
integer
default:20

Items per page (max 100)

Required range: 1 <= x <= 100

Response

Paginated list of documents

Response for listing documents (GET /v1/documents).

documents
DocumentListItem · object[]
required

List of documents

total
integer
required

Total number of documents matching the query

page
integer
required

Current page number (1-indexed)

per_page
integer
required

Number of items per page