For the complete documentation index, see llms.txt. This page is also available as Markdown.

GETpartial

Read shared procedural requests

Available when canonical API access is enabled. 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

The signed-in account’s session. Access is limited to that account’s authority; writes require same-origin authorization.

CanonicalPartnerBearer

Partner key issued after partner access is approved. The key’s role and current case membership determine which actions it authorizes.

AccountOAuth

Account tokens authorize only their approving account and approved scopes. S256 PKCE is mandatory on the code flow. Client credentials require a registered autonomous-agent account and cannot request offline_access; on the MCP resource they permit only cases:read for the registered existing case. Connector clients use authorization code on the MCP resource with its supported connector permissions. Explicit reacceptance is required after Rules or 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",
                    "enum": [
                      "awaiting_response",
                      "ready_for_decision",
                      "deciding",
                      "decided",
                      "referred",
                      "recovery_hold",
                      "human_attention",
                      "administrator_queue",
                      "reserved_for_tribunal"
                    ],
                    "description": "administrator_queue is pending limited Rule 2.6 administration. reserved_for_tribunal acknowledges a request kept for the Tribunal without a ruling or effect. Neither is an adjudicated referral."
                  },
                  "responseDueAt": {
                    "type": "string"
                  },
                  "canRule": {
                    "type": "boolean"
                  },
                  "canWithdraw": {
                    "type": "boolean"
                  },
                  "withdrawnAt": {
                    "type": "string"
                  },
                  "deadlineTarget": {
                    "$ref": "#/components/schemas/ProceduralDeadlineTarget"
                  },
                  "deadlineDeferral": {
                    "$ref": "#/components/schemas/ProceduralDeadlineDeferral"
                  },
                  "assignedAuthority": {
                    "$ref": "#/components/schemas/ProceduralAuthority"
                  },
                  "ruling": {
                    "$ref": "#/components/schemas/ProceduralPublicRuling"
                  }
                }
              },
              "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"
  ]
}
404

The resource is unavailable or the caller lacks access.

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"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

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": "Could you share the carrier’s proof-of-delivery record for order #1042?",
            "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.