GETpartial

Read isolated synthetic stage samples

Uses a separate sandbox credential issued once in the partner console. Ordinary partner and live credentials are refused. Reset invalidates the previous sandbox credential. Samples are not filed proceedings or signed Awards and cannot call providers or complete integration milestones. The workflow field describes the isolation and synthetic nature of the separate local workflow. It does not advertise a hosted mutation or control endpoint.

/api/sandbox/{partnerId}/caseslistPartnerSandboxCases

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

PartnerSandboxBearer

Isolated sandbox credential; never accepted by the ordinary Partner API.

Parameters

NameLocationRequirementSchema
partnerIdpathRequired{"type":"string"}

Responses

200

The current synthetic sandbox generation.

application/json

{
  "type": "object",
  "required": [
    "ok",
    "data"
  ],
  "properties": {
    "ok": {
      "const": true
    },
    "data": {
      "$ref": "#/components/schemas/PartnerIntegrationSandbox",
      "type": "object",
      "required": [
        "id",
        "environment",
        "generation",
        "createdAt",
        "cases"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "environment": {
          "const": "test"
        },
        "generation": {
          "type": "integer",
          "minimum": 1
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "workflow": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "isolation",
            "synthetic"
          ],
          "properties": {
            "isolation": {
              "const": "temporary_local_process"
            },
            "synthetic": {
              "const": true
            }
          }
        },
        "cases": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "schemaVersion",
              "synthetic",
              "environment",
              "stage",
              "parties",
              "claim",
              "decision",
              "execution",
              "nextStep"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "schemaVersion": {
                "const": "sandbox-case-v1"
              },
              "synthetic": {
                "const": true
              },
              "environment": {
                "const": "test"
              },
              "stage": {
                "enum": [
                  "prepared_filing",
                  "awaiting_answer",
                  "exchange",
                  "served_award",
                  "appeal_pending",
                  "final"
                ]
              },
              "parties": {
                "type": "object",
                "required": [
                  "claimant",
                  "respondent"
                ],
                "properties": {
                  "claimant": {
                    "type": "string"
                  },
                  "respondent": {
                    "type": "string"
                  }
                }
              },
              "claim": {
                "type": "object",
                "required": [
                  "currency",
                  "minorUnits"
                ],
                "properties": {
                  "currency": {
                    "const": "USD"
                  },
                  "minorUnits": {
                    "const": "10000"
                  }
                }
              },
              "decision": {
                "type": "object",
                "required": [
                  "served",
                  "final",
                  "appealPending"
                ],
                "properties": {
                  "served": {
                    "type": "boolean"
                  },
                  "final": {
                    "type": "boolean"
                  },
                  "appealPending": {
                    "type": "boolean"
                  }
                }
              },
              "execution": {
                "type": "object",
                "required": [
                  "mode",
                  "paymentConfirmed"
                ],
                "properties": {
                  "mode": {
                    "const": "disabled"
                  },
                  "paymentConfirmed": {
                    "const": false
                  }
                }
              },
              "nextStep": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
default

Sandbox credential, tenant status or rate-limit refusal.

application/json

{
  "type": "object",
  "required": [
    "ok",
    "error"
  ],
  "properties": {
    "ok": {
      "const": false
    },
    "error": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "ok": true,
  "data": {
    "id": "id_test",
    "environment": "test",
    "generation": 1,
    "createdAt": "2026-08-09T12:00:00.000Z",
    "cases": [
      {
        "id": "id_test",
        "schemaVersion": "sandbox-case-v1",
        "synthetic": true,
        "environment": "test",
        "stage": "prepared_filing",
        "parties": {
          "claimant": "claimant_test",
          "respondent": "respondent_test"
        },
        "claim": {
          "currency": "USD",
          "minorUnits": "10000"
        },
        "decision": {
          "served": false,
          "final": false,
          "appealPending": false
        },
        "execution": {
          "mode": "disabled",
          "paymentConfirmed": false
        },
        "nextStep": "nextStep_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.