Skip to main content

Cases

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

GET/v1/cases

Response

Response fields

dataarrayArray of case objects.
data[].idstringCase key (hex hash).
data[].case_keystringCase key (hex hash), same as id.
data[].labelstring | nullHuman-readable display name for the case.
data[].document_countintegerNumber of documents in the case.
data[].created_atstring | nullISO 8601 timestamp of the earliest document in the case.
data[].links.selfstringURL to retrieve case detail.

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

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Link Keys