Sign in

v1

latestOpenAPI 3.0.02026-07-263365159.1 KB
Documents

Get Documents Summary

Retrieve a summary of your documents, grouped by document type. Each group includes a count of documents by their processing status.

get/api/v1/mew/apikey/documents/summary/

Headers

apikeystring required

Your personal API key for authentication.

Response

OK

errorstring

A message describing any errors encountered during the request.

error_codestring

A code representing the specific error encountered during the request.

statusstring

The status of the request.

status_codeinteger

The HTTP status code of the response.

Example response

{
  "data": {
    "disabled_doc_types": [
      "invoice"
    ],
    "document": {
      "can_upload": true,
      "category": "Procurement",
      "default": true,
      "doc_counts": {
        "all": 6,
        "processed": 6,
        "reviewing": 6
      },
      "doc_type": "invoice",
      "flags": {
        "has_updated_doc_settings": true,
        "how_adt_documents_stepper": true
      },
      "id": 1,
      "is_editable": true,
      "models": [],
      "title": "Invoice",
      "upload_email": "invoice_78@docs.docsumo.com",
      "user_id": "5ee52bb5cd4b9a1bd51df0543"
    }
  },
  "status": "success",
  "status_code": 200
}