Skip to main content
GET
/
api
/
v2
/
cases
List cases
curl --request GET \
  --url https://api.example.com/api/v2/cases
{
  "page": 123,
  "pageSize": 123,
  "total": 123,
  "items": [
    {
      "id": "<string>",
      "type": "<string>",
      "branchId": "<string>",
      "feeEarnerId": "<string>",
      "propertyPrice": 123,
      "propertyCurrency": "<string>",
      "reference": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

page
integer

Page number (1-based)

Required range: x >= 1
pageSize
integer

Page size (default 20, max 100)

Required range: 1 <= x <= 100
includeArchived
boolean

Include archived cases (soft-deleted)

Response

200 - application/json

Paginated list of cases

page
integer

Current page number

pageSize
integer

Number of items per page

total
integer

Total number of cases

items
object[]

Array of case objects