Skip to main content

Endpoint

MethodPathAuthDescription
GET/case-typesX-API-Key (read_only)Returns all available CaseType objects

CaseType Object

FieldTypeDescription
idstring (uuid)Unique identifier for the case type
namestringMachine-readable key (e.g., "personal_injury")
displayNamestring | nullHuman-friendly label for UI rendering
explanationstring | nullHuman-readable explanation of the case type

Sample Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "personal_injury",
      "displayName": "Personal Injury",
      "explanation": "Personal injury cases involving bodily harm or negligence"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "medical_malpractice",
      "displayName": "Medical Malpractice",
      "explanation": "Cases involving medical provider negligence or error"
    }
  ],
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-03-31T12:00:00Z"
  }
}

Best Practices

  • Validate case type selections against this endpoint before calling POST /sent-cases.
  • Cache responses to reduce load and ensure consistent dropdown ordering.
  • Use displayName when rendering options in a UI; fall back to name when displayName is null.

Working examples

See full request/response examples for reference-data endpoints.