Cases

List and retrieve cases — automatically created groups of 2+ related documents linked through shared field values with narrative summaries.

Cases are automatically created groups of two or more documents that are connected through shared transaction or reference entity values. For example, an invoice, a purchase order, and a delivery note sharing the same PO number form a case. Cases provide a high-level view of document relationships without needing to navigate the full graph.

Use this endpoint to retrieve all cases in your workspace for building case lists, dashboards, or approval queues. The response is ordered by most recent first based on the earliest document timestamp in each case. Each case includes a document_count and a stable case_key that you can use for subsequent detail lookups.

The response includes a links.self URL for each case that points to the case detail endpoint. The label field contains an auto-generated human-readable name when available, or null for cases that have not yet been labelled. The created_at field reflects the timestamp of the earliest document in the group.

Pair this endpoint with Case Graph to visualize individual cases, or with Document-Case Map for a flat document-to-case lookup. Cases are rebuilt automatically during backfill — if you have recently reclassified link keys, trigger a backfill first to ensure case assignments are up to date.

Response

{
  "data": [
    {
      "id": "a1b2c3d4e5f6a7b8",
      "case_key": "a1b2c3d4e5f6a7b8",
      "label": "Acme Corp Q4 Invoices",
      "document_count": 4,
      "created_at": "2024-09-14T10:32:00.000Z",
      "links": {
        "self": "/v1/cases/a1b2c3d4e5f6a7b8"
      }
    }
  ]
}

Errors