Endpoint
| Method | Path | Auth | Description |
|---|---|---|---|
GET | /case-types | X-API-Key (read_only) | Returns all available CaseType objects |
CaseType Object
| Field | Type | Description |
|---|---|---|
id | string (uuid) | Unique identifier for the case type |
name | string | Machine-readable key (e.g., "personal_injury") |
displayName | string | null | Human-friendly label for UI rendering |
explanation | string | null | Human-readable explanation of the case type |
Sample Response
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
displayNamewhen rendering options in a UI; fall back tonamewhendisplayNameisnull.
Working examples
See full request/response examples for reference-data endpoints.