cases

Retrieve a case by ID

Returns a single CRM case

get/cases/{id}

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/cases/{id}
  • Auth: none declared

Path parameters

idstring required

ID of the case to return

Response

success

idstring uuid
caseNamestring
statusstring
caseSourcestring
caseSizeCentsinteger

Case value in cents

potentialAdmitDatestring date-time
followUpDatestring date-time
createdAtstring date-time
tagsstring[]

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "caseName": "John Doe",
  "status": "New",
  "caseSizeCents": 10000,
  "potentialAdmitDate": "2024-01-01T00:00:00Z",
  "followUpDate": "2024-01-15T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "personSeekingTreatment": {
    "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
    "first": "John",
    "last": "Doe",
    "createdAt": "2024-01-01T00:00:00Z"
  },
  "caseOwner": {
    "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
    "email": "johndoe@ritclinic.ritten.io",
    "first": "Doe",
    "last": "John",
    "lastAccessedAt": "2024-01-15T14:32:00Z"
  },
  "contacts": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "first": "John",
      "last": "Doe",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "potentialPrograms": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "programName": "Residential",
      "programType": "clinical"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.