API reference

Documents

Documents are your uploaded invoices. Each one carries its extraction once processing completes.

List documents

GET

Every document in the workspace, newest first. Use limit and offset to page through them.

Query parameters

2 fields

limitinteger
Max results per page. Default 50.
offsetinteger
Number of results to skip.
curl "https://api.invoi.st/v1/documents?status=done&limit=20" \
  -H "Authorization: Bearer $INVOIST_API_KEY"
Response · 200
{
  "documents": [
    {
      "id": "01a01663-6802-7707-a847-13323ffab41e",
      "source": "api",
      "original_filename": "invoice.pdf",
      "content_type": "application/pdf",
      "byte_size": 182044,
      "status": "done",
      "created_at": "2026-08-19T09:14:08Z",
      "updated_at": "2026-08-19T09:14:11Z"
    }
  ]
}

Get a document

GET

One document plus its extraction. This is the endpoint to poll after POST /v1/extract: the extraction status moves from pending to processing to done, and the extracted fields fill in when it completes.

curl "https://api.invoi.st/v1/documents/01a01663-6802-7707-a847-13323ffab41e" \
  -H "Authorization: Bearer $INVOIST_API_KEY"
Response · 200
{
  "document": {
    "id": "01a01663-6802-7707-a847-13323ffab41e",
    "source": "api",
    "original_filename": "invoice.pdf",
    "content_type": "application/pdf",
    "byte_size": 182044,
    "status": "done",
    "created_at": "2026-08-19T09:14:08Z",
    "updated_at": "2026-08-19T09:14:11Z"
  },
  "extraction": {
    "id": "01a01663-6807-7549-8391-b2be347960cf",
    "document_id": "01a01663-6802-7707-a847-13323ffab41e",
    "engine": "invoist-extraction-v1",
    "status": "done",
    "invoice_number": "INV-1042",
    "invoice_date": "2026-07-18",
    "due_date": "2026-08-17",
    "vendor_name": "Acme Supply Co",
    "vendor_address": "220 Industrial Way, Reno, NV 89502",
    "customer_name": "Northgate Retail LLC",
    "currency": "USD",
    "subtotal_cents": 264900,
    "tax_cents": 20000,
    "total_cents": 284900,
    "confidence": {
      "invoice_number": 0.99,
      "vendor_name": 0.95,
      "total_cents": 0.98
    },
    "line_items": [
      {
        "description": "Steel brackets, 4in",
        "quantity": 40,
        "unit_price_cents": 4200,
        "line_total_cents": 168000
      }
    ],
    "error_message": null,
    "created_at": "2026-08-19T09:14:08Z",
    "updated_at": "2026-08-19T09:14:11Z"
  }
}