Skip to main content

Cases API

The Cases API allows you to manage case records within Records Rocket.

Get Case Details​

Retrieves the details for a specific case.

GET /api/cases/{caseId}

Parameters​

  • caseId (string, required): The unique identifier for the case.

Response​

Returns a CaseRecord object.

{
  "id": "...",
  "recordType": "caseRecord",
  "tenantId": "...",
  "status": "active",
  "createdAt": 1672617600000,
  "updatedAt": 1672617600000,
  "createdBy": "...",
  "caseId": "...",
  "claimNumber": "CN-54321",
  "caseType": "IME",
  "title": "Doe, John - Pulmonology IME",
  "description": "Evaluation of respiratory issues..."
}

Create a New Case​

Creates a new case record.

POST /api/cases/new

Request Body​

Requires a NewCaseProps object.

{
  "tenantId": "...",
  "claimNumber": "CN-54321",
  "caseType": "IME",
  "title": "Doe, John - Pulmonology IME",
  "description": "Evaluation of respiratory issues related to workplace exposure."
}

Response​

Returns the newly created CaseRecord object.

Update a Case​

Updates the details of an existing case.

PUT /api/cases/{caseId}/edit

Parameters​

  • caseId (string, required): The unique identifier for the case to update.

Request Body​

An object containing the fields to update.

{
  "title": "Doe, John - Updated Pulmonology IME",
  "description": "Updated description with new details."
}

Response​

A confirmation of the update.