Skip to content
DocsToSheets

List documents

GET
/api/Documents
 
curl --request GET \
  --url 'https://app.docstosheets.com/api/Documents?page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Returns the documents of a mailbox with pagination and optional status and split filters.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
mailboxId
string
page
integer format: int32
default: 1
pageSize
integer format: int32
default: 20
status
One of:
One of:
string
Allowed values: pending processing extracted failed permanentlyFailed
split
string
nullable

Responses

Section titled “ Responses ”

200

Section titled “200 ”
Media type application/json

Response for document list request.

object
items
required
Array<object>

Document list item (minimal fields for list view).

object
id
required
string
mailboxId
required
string
documentType
required
string
source
required

How the document entered the mailbox: email, upload, or manual.

string
displaySubject
string
nullable
displayFrom
string
nullable
originalFileName
string
nullable
status
required
string
createdAt
required
string format: date-time
processedAt
string format: date-time
nullable
googleDriveUploadStatus
required
string
googleDriveFileWebViewLink
string
nullable
totalCount
required
integer format: int32
page
required
integer format: int32
pageSize
required
integer format: int32
Example generated
{
  "items": [
    {
      "id": "example",
      "mailboxId": "example",
      "documentType": "example",
      "source": "example",
      "displaySubject": "example",
      "displayFrom": "example",
      "originalFileName": "example",
      "status": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "processedAt": "2026-04-15T12:00:00Z",
      "googleDriveUploadStatus": "example",
      "googleDriveFileWebViewLink": "example"
    }
  ],
  "totalCount": 1,
  "page": 1,
  "pageSize": 1
}

400

Section titled “400 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}