Retrieve all Cases

This endpoint allows you to retrieve all case

GET {{baseurl}}/v2/api/cases

Headers

Name	Type	Description
token*	String	API secret token

Parameter

Field	Type	Description
next	String	Cursor for next page in pagination
prev	String	Cursor for previous page in pagination
sortField	String	Field to sort by
sortOrder	String	Sort order, either 'asc' or 'desc', sortField must be set for this to take effect
searchTerm	String	Search query
limit	String	number of cases to return Default value: 20
startDate	String	cases filter start date
endDate	String	cases filter end date
status	String	approval state of the entity
entityId	String	Entity Id to filter cases by
investigatorId	String	Id of the investigator to filter cases by

Retrieve all Cases Success Response

{
        "success": true,
        "statusCode": 200,
        "message": "Cases retrieved successfully!",
        "data": {
            "docs": [
                {
                    "caseTitle": "KYC data Mismatch",
                    "status": "Opened",
                    "caseType": "KYC",
                    "severity": "High",
                    "parentId": null,
                    "businessId": "681d7b30cd275833cb856ff8",
                    "entityId": "6880a452495dce07d2f7ff5a",
                    "description": "The case was created because there's a complete mismatch between the NIN and BVN data of the client.",
                    "evidences": [],
                    "linkedIssues": [
                        {
                            "issueId": "6880f7d527309cf76eb5db2e",
                            "issueType": "Activity",
                            "dateLinked": null,
                            "status": "Mismatch"
                        }
                    ],
                    "caseStage": [
                        {
                            "stage": "Investigation",
                            "level": "LV1",
                            "investigatorId": "681d7b32cd275833cb856fff",
                            "investigatorName": "Jaymee Bottomore",
                            "notes": [],
                            "isReassigned": false,
                            "previousInvestigators": [],
                            "tasks": [
                                {
                                    "task": "Investigate KYC verification",
                                    "isCompleted": false
                                },
                                {
                                    "task": "Gather evidences, and add them to the case.",
                                    "isCompleted": false
                                },
                                {
                                    "task": "Confirm if entities are same and why there's a mismatch",
                                    "isCompleted": false
                                }
                            ],
                            "_id": "68945a37a52eb93b87f827fa"
                        }
                    ],
                    "activities": [
                        {
                            "event": "Case Created",
                            "activity": "Case created by Jaymee Bottomore",
                            "createdBy": "Jaymee Bottomore",
                            "userId": "681d7b30cd275833cb856ff8",
                            "eventDateTime": "2025-08-07T07:48:07.145Z",
                            "_id": "68945a37a52eb93b87f827fb"
                        }
                    ],
                    "isDeleted": false,
                    "comments": [],
                    "createdAt": "2025-08-07T07:48:07.165Z",
                    "lastModifiedAt": "2025-08-07T07:48:07.165Z",
                    "_createdAt": "2025-08-07T08:48:077+01:00",
                    "_lastModifiedAt": "2025-08-07T08:48:077+01:00",
                    "id": "cas_68945a37a52eb93b87f827f9"
                },
                // ... more cases
            ],
            "pagination": {
                "type": "cursor",
                "perPage": 20,
                "nextPage": null,
                "prevPage": null,
                "hasNextPage": false,
                "hasPrevPage": false
            },
            "searchTerms": {}
        },
        "links": []
    }

Untitled

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}