GETpartial

Read an authorized case view

Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.

/api/cases/{id}getCasePreview

Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

CanonicalPartnerBearer

CanonicalSession

AccountOAuth

Account tokens authorize only their approving account and case scope. S256 PKCE is mandatory on the code flow. Explicit reacceptance is required after Rules/disclosure changes.

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}
x-pc-compatibility

Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials.

headerOptional{"type":"string","enum":["v1"]}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalCaseViewEnvelope",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalCaseView",
      "type": "object",
      "required": [
        "id",
        "revision",
        "environment",
        "externalReferences",
        "procedure",
        "stage",
        "deadlines",
        "availableActions",
        "waitingOn",
        "decision",
        "execution",
        "links"
      ],
      "description": "Caller-scoped authorized case resource. Every field is projected from stored state and the same policy used for writes.",
      "properties": {
        "id": {
          "type": "string"
        },
        "revision": {
          "type": "integer",
          "minimum": 0
        },
        "environment": {
          "type": "string",
          "enum": [
            "test",
            "live",
            "unspecified"
          ]
        },
        "externalReferences": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "source",
              "id"
            ],
            "properties": {
              "source": {
                "type": "string"
              },
              "id": {
                "type": "string"
              }
            }
          }
        },
        "procedure": {
          "type": "object",
          "required": [
            "mode",
            "caseMode",
            "rulesVersion",
            "rulesHash",
            "verifiedPrincipalBasis",
            "schedule"
          ],
          "properties": {
            "mode": {
              "type": "string",
              "description": "Procedural path. agent_only requires the exact bilateral autonomous-agent acceptance; a transport never selects it.",
              "enum": [
                "standard",
                "agent_only"
              ]
            },
            "caseMode": {
              "type": "string",
              "enum": [
                "proceeding",
                "evaluation"
              ]
            },
            "rulesVersion": {
              "type": [
                "string",
                "null"
              ]
            },
            "rulesHash": {
              "type": [
                "string",
                "null"
              ]
            },
            "verifiedPrincipalBasis": {
              "type": "string"
            },
            "schedule": {
              "type": "object",
              "required": [
                "deadlinePolicy"
              ],
              "properties": {
                "deadlinePolicy": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          }
        },
        "stage": {
          "type": "object",
          "required": [
            "code",
            "phase",
            "recordRevision"
          ],
          "properties": {
            "code": {
              "type": "string",
              "enum": [
                "awaiting_respondent",
                "exchange",
                "record_confirmation",
                "under_review",
                "served",
                "appeal",
                "final",
                "ended",
                "service_pending",
                "fee_pending"
              ]
            },
            "phase": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "answer",
                "evidence",
                "rebuttal",
                "close",
                "merits"
              ]
            },
            "recordRevision": {
              "type": "integer",
              "minimum": 0
            }
          }
        },
        "deadlines": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CanonicalCaseDeadline",
            "type": "object",
            "required": [
              "kind",
              "dueAt",
              "effect"
            ],
            "properties": {
              "kind": {
                "type": "string"
              },
              "party": {
                "type": "string",
                "enum": [
                  "claimant",
                  "respondent"
                ]
              },
              "dueAt": {
                "type": "string",
                "format": "date-time"
              },
              "effect": {
                "type": "string"
              }
            }
          }
        },
        "availableActions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CanonicalCaseAction",
            "type": "object",
            "required": [
              "code",
              "method",
              "href",
              "inputSchema",
              "expectedRevision",
              "requirements"
            ],
            "description": "One authorized, discoverable action. href is the canonical URL and inputSchema names the published request schema for it. requirements carry the exact values the operation checks, such as a record digest and its confirmation sentence; free-text fields remain the caller's.",
            "properties": {
              "code": {
                "type": "string"
              },
              "method": {
                "type": "string",
                "enum": [
                  "POST",
                  "PATCH",
                  "GET"
                ]
              },
              "href": {
                "type": "string"
              },
              "inputSchema": {
                "type": "string",
                "description": "Name of a schema published under components.schemas in this contract."
              },
              "expectedRevision": {
                "type": "integer",
                "minimum": 0
              },
              "requirements": {
                "type": "object",
                "properties": {
                  "party": {
                    "type": "string",
                    "enum": [
                      "claimant",
                      "respondent"
                    ]
                  },
                  "partyHeader": {
                    "type": "string",
                    "enum": [
                      "claimant",
                      "respondent"
                    ]
                  },
                  "recordDigest": {
                    "type": "string"
                  },
                  "confirmationStatement": {
                    "type": "string"
                  },
                  "inventoryDigest": {
                    "type": "string"
                  },
                  "agree": {
                    "type": "boolean"
                  },
                  "idempotencyKey": {
                    "type": "boolean"
                  },
                  "protocolPrincipal": {
                    "type": "string"
                  },
                  "protocolActor": {
                    "type": "string"
                  },
                  "evidenceAttestation": {
                    "type": "string"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "rule47Kind": {
                    "type": "string"
                  },
                  "rule47OrderId": {
                    "type": "string"
                  },
                  "submissionId": {
                    "type": "string"
                  },
                  "evidenceId": {
                    "type": "string"
                  },
                  "sourceId": {
                    "type": "string"
                  },
                  "grantId": {
                    "type": "string"
                  },
                  "requestId": {
                    "type": "string"
                  },
                  "channel": {
                    "type": "string"
                  },
                  "category": {
                    "type": "string"
                  },
                  "fee": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": "string"
                      },
                      "minorUnits": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "processing": {
          "$ref": "#/components/schemas/CanonicalCaseProcessingStatus",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "blocker",
            "lastProgress",
            "nextActor"
          ],
          "description": "Closed procedural codes projected from stored state. Outside under_review all three fields are null. These fields report workflow progress, not a merits result or completion estimate. No run logs, provider diagnostics, private record state, model identities or unserved work are exposed.",
          "properties": {
            "blocker": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "queued",
                "adjudication",
                "technical_failure",
                "procedure_hold",
                "ai_correction",
                "configuration_review",
                "operational_hold",
                "legacy_review",
                "award_service",
                "award_validation",
                "awaiting_start",
                null
              ]
            },
            "lastProgress": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "required": [
                "code",
                "at"
              ],
              "description": "Latest stored run milestone; at is its completion, start or creation time, not a heartbeat.",
              "properties": {
                "code": {
                  "type": "string",
                  "enum": [
                    "queued",
                    "started",
                    "completed",
                    "failed",
                    "interrupted",
                    "timed_out",
                    "cancelled"
                  ]
                },
                "at": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            "nextActor": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "service",
                "administrator",
                "tribunal",
                "legacy_reviewer",
                null
              ]
            }
          }
        },
        "waitingOn": {
          "description": "During under_review, reason uses the processing.blocker code.",
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "kind",
              "reason"
            ],
            "properties": {
              "kind": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              },
              "party": {
                "type": "string"
              },
              "dueAt": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "decision": {
          "type": "object",
          "required": [
            "served",
            "servedAt",
            "awardId",
            "hash",
            "revision",
            "appellateDisposition",
            "postAppealRequestScope",
            "appealEligible",
            "appealDeadline",
            "finality",
            "executable",
            "holdReasons"
          ],
          "description": "Served, appealable, final and executable are separate facts. A served Award may remain stayed.",
          "properties": {
            "served": {
              "type": "boolean"
            },
            "servedAt": {
              "type": [
                "string",
                "null"
              ]
            },
            "awardId": {
              "type": [
                "string",
                "null"
              ]
            },
            "hash": {
              "type": [
                "string",
                "null"
              ]
            },
            "revision": {
              "type": [
                "integer",
                "null"
              ]
            },
            "appellateDisposition": {
              "type": [
                "object",
                "null"
              ],
              "required": [
                "outcome",
                "servedAt",
                "operativeAward"
              ],
              "properties": {
                "outcome": {
                  "type": "string"
                },
                "servedAt": {
                  "type": "string"
                },
                "operativeAward": {
                  "type": "string"
                }
              }
            },
            "postAppealRequestScope": {
              "description": "Pinned scope of post-appeal requests, or null when none applies."
            },
            "appealEligible": {
              "type": "boolean"
            },
            "appealDeadline": {
              "type": [
                "string",
                "null"
              ]
            },
            "finality": {
              "type": "string",
              "enum": [
                "not_served",
                "served",
                "appealable",
                "appeal_reserved",
                "appeal_pending",
                "final"
              ]
            },
            "executable": {
              "type": "boolean"
            },
            "holdReasons": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "execution": {
          "type": "object",
          "required": [
            "status",
            "links"
          ],
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "not_configured",
                "not_requested",
                "pending",
                "confirmed",
                "needs_action",
                "blocked",
                "failed",
                "unknown_outcome"
              ]
            },
            "links": {
              "type": "object",
              "description": "Present only where an execution operation or receipt exists and the caller's interface can resolve it. Following them needs the separate settlement-execution credential.",
              "properties": {
                "operations": {
                  "type": "string"
                },
                "receipts": {
                  "type": "string"
                }
              }
            }
          }
        },
        "links": {
          "type": "object",
          "description": "Authorized resources for this caller. No invitation secret is ever returned here.",
          "properties": {
            "casePage": {
              "type": "string"
            },
            "artifacts": {
              "type": "string"
            },
            "docket": {
              "type": "string"
            },
            "recordBundle": {
              "type": "string"
            },
            "eventCursor": {
              "type": "string"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
201

Answer or invitation created through the shared partner operation.

application/json

{
  "$ref": "#/components/schemas/CanonicalCaseViewEnvelope",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalCaseView",
      "type": "object",
      "required": [
        "id",
        "revision",
        "environment",
        "externalReferences",
        "procedure",
        "stage",
        "deadlines",
        "availableActions",
        "waitingOn",
        "decision",
        "execution",
        "links"
      ],
      "description": "Caller-scoped authorized case resource. Every field is projected from stored state and the same policy used for writes.",
      "properties": {
        "id": {
          "type": "string"
        },
        "revision": {
          "type": "integer",
          "minimum": 0
        },
        "environment": {
          "type": "string",
          "enum": [
            "test",
            "live",
            "unspecified"
          ]
        },
        "externalReferences": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "source",
              "id"
            ],
            "properties": {
              "source": {
                "type": "string"
              },
              "id": {
                "type": "string"
              }
            }
          }
        },
        "procedure": {
          "type": "object",
          "required": [
            "mode",
            "caseMode",
            "rulesVersion",
            "rulesHash",
            "verifiedPrincipalBasis",
            "schedule"
          ],
          "properties": {
            "mode": {
              "type": "string",
              "description": "Procedural path. agent_only requires the exact bilateral autonomous-agent acceptance; a transport never selects it.",
              "enum": [
                "standard",
                "agent_only"
              ]
            },
            "caseMode": {
              "type": "string",
              "enum": [
                "proceeding",
                "evaluation"
              ]
            },
            "rulesVersion": {
              "type": [
                "string",
                "null"
              ]
            },
            "rulesHash": {
              "type": [
                "string",
                "null"
              ]
            },
            "verifiedPrincipalBasis": {
              "type": "string"
            },
            "schedule": {
              "type": "object",
              "required": [
                "deadlinePolicy"
              ],
              "properties": {
                "deadlinePolicy": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              }
            }
          }
        },
        "stage": {
          "type": "object",
          "required": [
            "code",
            "phase",
            "recordRevision"
          ],
          "properties": {
            "code": {
              "type": "string",
              "enum": [
                "awaiting_respondent",
                "exchange",
                "record_confirmation",
                "under_review",
                "served",
                "appeal",
                "final",
                "ended",
                "service_pending",
                "fee_pending"
              ]
            },
            "phase": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "answer",
                "evidence",
                "rebuttal",
                "close",
                "merits"
              ]
            },
            "recordRevision": {
              "type": "integer",
              "minimum": 0
            }
          }
        },
        "deadlines": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CanonicalCaseDeadline",
            "type": "object",
            "required": [
              "kind",
              "dueAt",
              "effect"
            ],
            "properties": {
              "kind": {
                "type": "string"
              },
              "party": {
                "type": "string",
                "enum": [
                  "claimant",
                  "respondent"
                ]
              },
              "dueAt": {
                "type": "string",
                "format": "date-time"
              },
              "effect": {
                "type": "string"
              }
            }
          }
        },
        "availableActions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CanonicalCaseAction",
            "type": "object",
            "required": [
              "code",
              "method",
              "href",
              "inputSchema",
              "expectedRevision",
              "requirements"
            ],
            "description": "One authorized, discoverable action. href is the canonical URL and inputSchema names the published request schema for it. requirements carry the exact values the operation checks, such as a record digest and its confirmation sentence; free-text fields remain the caller's.",
            "properties": {
              "code": {
                "type": "string"
              },
              "method": {
                "type": "string",
                "enum": [
                  "POST",
                  "PATCH",
                  "GET"
                ]
              },
              "href": {
                "type": "string"
              },
              "inputSchema": {
                "type": "string",
                "description": "Name of a schema published under components.schemas in this contract."
              },
              "expectedRevision": {
                "type": "integer",
                "minimum": 0
              },
              "requirements": {
                "type": "object",
                "properties": {
                  "party": {
                    "type": "string",
                    "enum": [
                      "claimant",
                      "respondent"
                    ]
                  },
                  "partyHeader": {
                    "type": "string",
                    "enum": [
                      "claimant",
                      "respondent"
                    ]
                  },
                  "recordDigest": {
                    "type": "string"
                  },
                  "confirmationStatement": {
                    "type": "string"
                  },
                  "inventoryDigest": {
                    "type": "string"
                  },
                  "agree": {
                    "type": "boolean"
                  },
                  "idempotencyKey": {
                    "type": "boolean"
                  },
                  "protocolPrincipal": {
                    "type": "string"
                  },
                  "protocolActor": {
                    "type": "string"
                  },
                  "evidenceAttestation": {
                    "type": "string"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "rule47Kind": {
                    "type": "string"
                  },
                  "rule47OrderId": {
                    "type": "string"
                  },
                  "submissionId": {
                    "type": "string"
                  },
                  "evidenceId": {
                    "type": "string"
                  },
                  "sourceId": {
                    "type": "string"
                  },
                  "grantId": {
                    "type": "string"
                  },
                  "requestId": {
                    "type": "string"
                  },
                  "channel": {
                    "type": "string"
                  },
                  "category": {
                    "type": "string"
                  },
                  "fee": {
                    "type": "object",
                    "properties": {
                      "currency": {
                        "type": "string"
                      },
                      "minorUnits": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "processing": {
          "$ref": "#/components/schemas/CanonicalCaseProcessingStatus",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "blocker",
            "lastProgress",
            "nextActor"
          ],
          "description": "Closed procedural codes projected from stored state. Outside under_review all three fields are null. These fields report workflow progress, not a merits result or completion estimate. No run logs, provider diagnostics, private record state, model identities or unserved work are exposed.",
          "properties": {
            "blocker": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "queued",
                "adjudication",
                "technical_failure",
                "procedure_hold",
                "ai_correction",
                "configuration_review",
                "operational_hold",
                "legacy_review",
                "award_service",
                "award_validation",
                "awaiting_start",
                null
              ]
            },
            "lastProgress": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": false,
              "required": [
                "code",
                "at"
              ],
              "description": "Latest stored run milestone; at is its completion, start or creation time, not a heartbeat.",
              "properties": {
                "code": {
                  "type": "string",
                  "enum": [
                    "queued",
                    "started",
                    "completed",
                    "failed",
                    "interrupted",
                    "timed_out",
                    "cancelled"
                  ]
                },
                "at": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            "nextActor": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "service",
                "administrator",
                "tribunal",
                "legacy_reviewer",
                null
              ]
            }
          }
        },
        "waitingOn": {
          "description": "During under_review, reason uses the processing.blocker code.",
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "kind",
              "reason"
            ],
            "properties": {
              "kind": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              },
              "party": {
                "type": "string"
              },
              "dueAt": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "decision": {
          "type": "object",
          "required": [
            "served",
            "servedAt",
            "awardId",
            "hash",
            "revision",
            "appellateDisposition",
            "postAppealRequestScope",
            "appealEligible",
            "appealDeadline",
            "finality",
            "executable",
            "holdReasons"
          ],
          "description": "Served, appealable, final and executable are separate facts. A served Award may remain stayed.",
          "properties": {
            "served": {
              "type": "boolean"
            },
            "servedAt": {
              "type": [
                "string",
                "null"
              ]
            },
            "awardId": {
              "type": [
                "string",
                "null"
              ]
            },
            "hash": {
              "type": [
                "string",
                "null"
              ]
            },
            "revision": {
              "type": [
                "integer",
                "null"
              ]
            },
            "appellateDisposition": {
              "type": [
                "object",
                "null"
              ],
              "required": [
                "outcome",
                "servedAt",
                "operativeAward"
              ],
              "properties": {
                "outcome": {
                  "type": "string"
                },
                "servedAt": {
                  "type": "string"
                },
                "operativeAward": {
                  "type": "string"
                }
              }
            },
            "postAppealRequestScope": {
              "description": "Pinned scope of post-appeal requests, or null when none applies."
            },
            "appealEligible": {
              "type": "boolean"
            },
            "appealDeadline": {
              "type": [
                "string",
                "null"
              ]
            },
            "finality": {
              "type": "string",
              "enum": [
                "not_served",
                "served",
                "appealable",
                "appeal_reserved",
                "appeal_pending",
                "final"
              ]
            },
            "executable": {
              "type": "boolean"
            },
            "holdReasons": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "execution": {
          "type": "object",
          "required": [
            "status",
            "links"
          ],
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "not_configured",
                "not_requested",
                "pending",
                "confirmed",
                "needs_action",
                "blocked",
                "failed",
                "unknown_outcome"
              ]
            },
            "links": {
              "type": "object",
              "description": "Present only where an execution operation or receipt exists and the caller's interface can resolve it. Following them needs the separate settlement-execution credential.",
              "properties": {
                "operations": {
                  "type": "string"
                },
                "receipts": {
                  "type": "string"
                }
              }
            }
          }
        },
        "links": {
          "type": "object",
          "description": "Authorized resources for this caller. No invitation secret is ever returned here.",
          "properties": {
            "casePage": {
              "type": "string"
            },
            "artifacts": {
              "type": "string"
            },
            "docket": {
              "type": "string"
            },
            "recordBundle": {
              "type": "string"
            },
            "eventCursor": {
              "type": "string"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
404

Preview disabled or resource unavailable.

default

Stable problem code and requestId; no protected state disclosed.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "id": "id_test",
    "revision": 1,
    "environment": "test",
    "externalReferences": [
      {
        "source": "source_test",
        "id": "id_test"
      }
    ],
    "procedure": {
      "mode": "standard",
      "caseMode": "proceeding",
      "rulesVersion": null,
      "rulesHash": null,
      "verifiedPrincipalBasis": "verifiedPrincipalBasis_test",
      "schedule": {
        "deadlinePolicy": null
      }
    },
    "stage": {
      "code": "awaiting_respondent",
      "phase": "answer",
      "recordRevision": 1
    },
    "deadlines": [
      {
        "kind": "kind_test",
        "dueAt": "2026-08-09T12:00:00.000Z",
        "effect": "effect_test"
      }
    ],
    "availableActions": [
      {
        "code": "code_test",
        "method": "POST",
        "href": "href_test",
        "inputSchema": "inputSchema_test",
        "expectedRevision": 1,
        "requirements": {}
      }
    ],
    "waitingOn": [
      {
        "kind": "kind_test",
        "reason": "reason_test"
      }
    ],
    "decision": {
      "served": false,
      "servedAt": null,
      "awardId": null,
      "hash": null,
      "revision": null,
      "appellateDisposition": null,
      "postAppealRequestScope": {},
      "appealEligible": false,
      "appealDeadline": null,
      "finality": "not_served",
      "executable": false,
      "holdReasons": [
        "holdReasons_test"
      ]
    },
    "execution": {
      "status": "not_configured",
      "links": {}
    },
    "links": {}
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.