Skip to content

Get Case

Overview

Retrieve case details for an organisation.

Method and endpoint

GET /v1/{organisation}/case

Path Parameters

  • organisation (string, required)

Query Parameters

  • case_number (string, optional)
  • external_ref (string, optional)

HTTP Request

GET /api/{organisation}/case

Success Response (200) Schema

Object (implementation specific)

Response Example

{
  "case_id": "CASE12345",
  "company": "AfriForum",
  "external_ref": "EXT12345",
  "subject": "Service Complaint",
  "category": "Complaint",
  "description": "Member complaint regarding delayed service.",
  "creator_idno": "8001015009087",
  "creator_name": "John",
  "creator_surname": "Doe",
  "creator_cellphone": "0821234567",
  "creator_email": "john.doe@example.com",
  "attachment": [
    {
      "filename": "evidence.pdf",
      "url": "https://example.com/evidence.pdf"
    }
  ],
  "status": "OPEN"
}

Error Responses

  • 400 Validation Exception (Bad Request)