Case Documents

Case documents represent generated or attached documents tied to a case record — such as orders, notices, or minutes produced from a case activity.

This resource is currently read-only through the API. The back-office store/update/destroy actions exist as controller stubs but are not implemented — documents are produced as a side effect of other workflows (e.g. Case Activities), not created directly.

The case document model

Name
id
Type
string
Description
Unique UUID identifier for the document.
Name
title
Type
string
Description
The document's title.
Name
type
Type
string
Description
The document type, e.g. Order, Notice, Minutes.
Name
description
Type
string | null
Description
Free-text description. Documents with a description of Hearing or JDR are excluded from the back-office listing.
Name
data
Type
object | null
Description
Arbitrary structured data associated with the document (cast to an array).
Name
case_record_id
Type
string
Description
The case record this document belongs to.
Name
case_activity_id
Type
string | null
Description
The case activity that generated this document, if any.
Name
created_at
Type
timestamp
Description
Timestamp when the document was created.
Name
updated_at
Type
timestamp
Description
Timestamp when the document was last updated.

GET/api/case-documents

List your case documents

Retrieve case documents belonging to cases the authenticated user collaborates on.

Request

GET

/api/case-documents

curl https://your-domain.com/api/case-documents \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}"

Response

{
  "data": [
    {
      "id": "d1e2f3a4-b5c6-7890-def1-234567890abc",
      "title": "Order Setting Case for Pre-Trial",
      "type": "Order",
      "description": null,
      "case_record_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "case_activity_id": "e5f6a7b8-c9d0-1234-ef56-7890abcdef12",
      "created_at": "2026-02-12T10:00:00+00:00",
      "updated_at": "2026-02-12T10:00:00+00:00"
    }
  ]
}

GET/api/backoffice/case-documents

List case documents (back office)

Retrieve case documents across all branches, filterable by branch and search term.

Optional attributes

Name
branch_id
Type
string
Description
Filter to documents belonging to cases assigned to a specific branch.
Name
search
Type
string
Description
Search by document title or description.

Request

GET

/api/backoffice/case-documents

curl -G https://your-domain.com/api/backoffice/case-documents \
  -H "Accept: application/json" \
  -H "X-XSRF-TOKEN: {token}" \
  --cookie "cms_admin_session={session}" \
  --data-urlencode "search=Pre-Trial"

Response

{
  "data": [
    {
      "id": "d1e2f3a4-b5c6-7890-def1-234567890abc",
      "title": "Order Setting Case for Pre-Trial",
      "type": "Order",
      "case_record_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "created_at": "2026-02-12T10:00:00+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1
  }
}