PARSER GUIDES

List Documents

GET

/api/v1/parsers/{parserId}/documents

List documents for a parser with search, filters, sorting, and bounded pagination. This endpoint returns a compact document row. Use Get Document for the full document view.

Authorization

bearerAuth

authorization: <token>

Your API key. Include it directly in the Authorization header as the API key value (e.g., 'authorization: your-api-key-here')

In: header

Path Parameters

parserId — string

The ID of the parser

Format: uuid

Query Parameters

q?string

Search by document name or external ID.

status?string

Filter by document processing status.

Value in"uploading" | "queued" | "processing" | "processed" | "failed" | "in_review" | "approved" | "rejected"

folderId?string

Filter by folder ID.

Format: uuid

assigneeId?string

Filter documents assigned to a reviewer.

Format: uuid

reviewStageId?string

Filter documents currently pending or in progress for a review stage.

externalId?string

Filter by exact external ID.

createdFrom?string

Return documents created on or after this timestamp.

Format: date-time

createdTo?string

Return documents created on or before this timestamp.

Format: date-time

sort?string

Sort order. Defaults to createdAt.desc.

Value in"createdAt.desc" | "createdAt.asc" | "updatedAt.desc" | "updatedAt.asc" | "name.asc" | "name.desc"

page?integer

Page number.

Default1

Range1 <= value

limit?integer

Results per page. Maximum is 100.

Default50

Range1 <= value <= 100

Response Body

200

application/json

400

application/json

401

application/json

404

application/json

curl -X GET "https://api.PARSER.com/api/v1/parsers/d1458cd7-8692-488f-8b3f-0fddade05f9c/documents"

200400401404

{
  "data": [
    {
      "id": "2b9b1243-3d94-42b0-9515-729c7404e3b7",
      "name": "sample-invoice.pdf",
      "externalId": "doc-123",
      "custom": {
        "batchId": "xyz",
        "customerId": "pqr"
      },
      "status": "processed",
      "folderId": "76e4f0ef-15d0-4bde-8c0e-43d361c0795c",
      "source": "api",
      "contentType": "application/pdf",
      "createdAt": "2026-01-23T18:11:47.319Z",
      "updatedAt": "2026-01-23T18:12:29.860Z",
      "isProcessed": true,
      "isFailed": false,
      "pageCount": 1,
      "review": {
        "isRequired": true,
        "status": "not_required",
        "assignee": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "Jane Reviewer",
          "email": "contact@parser.example"
        },
        "currentStage": {
          "id": "string",
          "name": "string",
          "reviewerInstructions": "string",
          "position": 0
        },
        "stages": [
          {
            "id": "string",
            "name": "string",
            "reviewerInstructions": "string",
            "position": 0,
            "status": "pending",
            "assignee": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "Jane Reviewer",
              "email": "contact@parser.example"
            },
            "approvedAt": "2019-08-24T14:15:22Z",
            "rejectedAt": "2019-08-24T14:15:22Z"
          }
        ]
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 128,
    "pageCount": 3
  }
}

{
  "error": true,
  "message": "Parser ID mismatch"
}

{
  "error": true,
  "message": "Parser ID mismatch"
}

{
  "error": true,
  "message": "Document not found",
  "notFound": [
    {
      "type": "documentId",
      "value": "string"
    }
  ]
}