Retrieve an Activity

This endpoint allows you to retrieve the activity for an entity.

GET {{baseurl}}/v2/api/activities

Headers

Name	Type	Description
token*	String	API secret token

Parameter

Field	Type	Description
entityId	String	Entity ID to filter activities.
limit	String	Number of records to return Default value: 10
sortField	String	Field to sort results by Default value: createdAt
sortOrder	String	Sort order Default value: desc Allowed values: "asc", "desc"
next	String	Cursor for fetching the next page (value of sortField from last item)
prev	String	Cursor for fetching the previous page (value of sortField from first item)
type	String	Filter by activity type
status	String	Filter by activity status
startDate	Date	Filter activities created after this date.
endDate	Date	Filter activities created before this date.

Retrieve an Activity Success Response

{
          "success": true,
          "statusCode": 200,
          "message": "Activities successfully retrieved!",
          "data": {
              "docs": [
                  {
                      "entityId": "68b0114137593677539a1638",
                      "activity": "Identity Check",
                      "type": "bvn",
                      "reportId": "68c169c76271c8b9f0bc25c3",
                      "status": "found",
                      "createdAt": "2025-09-10T12:06:37.180Z",
                      "lastModifiedAt": "2025-09-10T12:06:37.180Z",
                      "_createdAt": "2025-09-10T12:06:3737+00:00",
                      "_lastModifiedAt": "2025-09-10T12:06:3737+00:00",
                      "id": "act_68c169cd9a12af3e53c5dc65",
                      "_id": "act_68c169cd9a12af3e53c5dc65"
                  },
                  {
                      "entityId": "68a58ea5b6028250659992e7",
                      "activity": "Identity Check",
                      "type": "bvn",
                      "reportId": "68a596ea37ff853c82517fb9",
                      "status": "found",
                      "createdAt": "2025-08-20T09:35:43.621Z",
                      "lastModifiedAt": "2025-08-20T09:35:43.621Z",
                      "_createdAt": "2025-08-20T09:35:4343+00:00",
                      "_lastModifiedAt": "2025-08-20T09:35:4343+00:00",
                      "id": "act_68a596ef9a12af3e53ba7e1c",
                      "_id": "act_68a596ef9a12af3e53ba7e1c"
                  }
              ],
              "pagination": {
                "type": "cursor",
                "perPage": 20,
                "nextPage": "2025-08-15T15:31:51.922Z",
                "prevPage": null,
                "hasNextPage": true,
                "hasPrevPage": false
            },
              "filters": {}
          },
          "links": []
}