Skip to main content
GET
/
api
/
cases
List all cases
curl --request GET \
  --url http://localhost/api/api/cases \
  --header 'Authorization: Bearer <token>'
{
  "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"
}
Note: You may indicate specific queries by the rule, assignee, subject_1, client_subject_id, caseStatus, bucket, id(case_id), and/or client_transaction_id to filter down to specific cases.

​
Filterable Fields

  • rule
  • assignee
  • subject_1
  • client_subject_id
  • caseStatus
  • bucket
  • client_transaction_id
Multiple fields can be filtered at the same time. Fields can be linked as shown in the same request URL where rule and assignee are both used as the queries. The different queries can be joined by ’&’ Default Order By
  • case_status_order (1st)
  • ageing (2nd)
Optional Order By
  • priority
  • created_on
  • ageing
  • rule_rule_number_id
  • bucket_id
  • case_status_order
  • assignee_id

Authorizations

​
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
​
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"