List all cases

Retrieve a list of all cases with optional filtering and ordering.

GET /api/cases

List all cases

cURL

curl --request GET \
  --url http://localhost/api/api/cases \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "results": [
    {
      "ageing": 123,
      "priority": 123,
      "case_status_order": 123,
      "alert_date": "<string>",
      "alert_risk_rating": "<string>",
      "assignee": {
        "id": 123,
        "name": "<string>"
      },
      "bucket": {
        "id": 123,
        "name": "<string>"
      },
      "case_action": "<string>",
      "case_status": "<string>",
      "case_subjects": {
        "subject_1": {
          "id": 123,
          "name": "<string>",
          "client_subject_id": "<string>"
        },
        "subject_2": {
          "id": 123,
          "name": "<string>",
          "client_subject_id": "<string>"
        }
      },
      "created_on": "<string>",
      "id": 123,
      "rule": 123,
      "active_timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

CustomAuthenticationcookieAuth

Authorization · string · header · required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

alert_risk_rating · string

assignee · string

bucket · string

case_status · string

client_subject_id · string

client_transaction_id · string

id · integer

limit · integer

Number of results to return per page.

max_date · string<date-time>

min_date · string<date-time>

offset · integer

The initial index from which to return the results.

ordering · string

Which field to use when ordering the results.

rule · string

subject_1 · string

Response

200 - application/json

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"