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

Summary

Review the available Cases API endpoints, authentication requirements, and supported operations.

The Cases API supports retrieving, creating, updating, and deleting Case records in Monolith.

Use this page as a quick reference for the available Cases API endpoints. See the individual endpoint pages for request parameters, validation rules, response examples, and sample API calls.

Base Path

/api/v1/cases

Use the API base URL for the Monolith environment where your tenant is hosted.

See API Endpoints for cloud-region and on-premises endpoint guidance.

Authentication

All Cases API endpoints require a valid Monolith API key in the following request header:

X-API-KEY: your_api_key

The Cases API does not use Authorization: Bearer authentication.

An invalid or missing API key returns an HTTP 401 Unauthorized response.

See Authentication for additional API authentication guidance.

Endpoint Summary

Method
Path
Purpose

GET

/api/v1/cases

Retrieve Cases with supported filtering and pagination.

GET

/api/v1/cases/:uuid

Retrieve a specific Case by UUID.

POST

/api/v1/cases

Create a new Case.

PUT

/api/v1/cases/:uuid

Update an existing Case.

DELETE

/api/v1/cases/:uuid

Delete a Case and associated dependent records.

Endpoint Documentation

Get Cases

Use GET /api/v1/cases to retrieve Cases or GET /api/v1/cases/:uuid to retrieve a specific Case.

See Get Cases for supported filters, pagination, and response details.

Create Case

Use POST /api/v1/cases to create a new Case.

See Create Case for supported fields, validation requirements, and response details.

Update Case

Use PUT /api/v1/cases/:uuid to update supported fields on an existing Case.

See Update Case for supported fields and validation requirements.

Delete Case

Use DELETE /api/v1/cases/:uuid to delete an existing Case.

See Delete Case for request and response details.

Last updated

Was this helpful?