GETpartial

Read shared procedural requests

Controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. The shared operation rechecks current authority and pinned Rules. Partner writes require procedural:request. This grants neither general hosted-message access nor ruling authority.

/api/cases/{id}/procedural-requestslistProceduralRequestsPreview

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.

CanonicalSession

CanonicalPartnerBearer

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"}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalListProceduralRequestsPreviewResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalProceduralRequestList",
      "type": "object",
      "properties": {
        "requests": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CanonicalHostedThread",
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "category": {
                "type": "string"
              },
              "visibility": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "createdAt": {
                "type": "string"
              },
              "updatedAt": {
                "type": "string"
              },
              "closedAt": {
                "type": "string"
              },
              "canReply": {
                "type": "boolean"
              },
              "proceduralRequest": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "requestedRelief": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "responseDueAt": {
                    "type": "string"
                  },
                  "canRule": {
                    "type": "boolean"
                  }
                }
              },
              "messages": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CanonicalHostedMessage",
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "sender": {
                      "type": "object",
                      "properties": {
                        "label": {
                          "type": "string"
                        },
                        "role": {
                          "type": "string"
                        },
                        "side": {
                          "type": "string",
                          "enum": [
                            "claimant",
                            "respondent"
                          ]
                        },
                        "onBehalfOfParty": {
                          "type": "string",
                          "enum": [
                            "claimant",
                            "respondent"
                          ]
                        },
                        "representative": {
                          "type": "object",
                          "properties": {
                            "displayName": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "displayName"
                          ]
                        }
                      },
                      "required": [
                        "label",
                        "role"
                      ]
                    },
                    "body": {
                      "type": "string"
                    },
                    "createdAt": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "sender",
                    "body",
                    "createdAt"
                  ]
                }
              }
            },
            "required": [
              "id",
              "category",
              "visibility",
              "status",
              "createdAt",
              "updatedAt",
              "canReply",
              "messages"
            ]
          }
        }
      },
      "required": [
        "requests"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ],
  "x-code-source": "lib/proceeding/messages.ts"
}
404

Preview disabled or authorized resource unavailable.

default

RFC 9457 style problem response.

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": {
    "requests": [
      {
        "id": "id_test",
        "category": "category_test",
        "visibility": "visibility_test",
        "status": "status_test",
        "createdAt": "createdAt_test",
        "updatedAt": "updatedAt_test",
        "canReply": false,
        "messages": [
          {
            "id": "id_test",
            "sender": {
              "label": "label_test",
              "role": "role_test"
            },
            "body": "body_test",
            "createdAt": "createdAt_test"
          }
        ]
      }
    ]
  },
  "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.