Retrieve CWB History

This endpoint returns your CWB history and can be filtered by start and end dates, as well as title.

GET {{baseurl}}/v2/api/v-forms/

Query Parameters

Name	Type	Description
page	Number	Page number of pagination
limit	Number	Limit of results to retrieve
startDate	Date	Filter Results by startDate, it requires a corresponding endDate. Both must be in YYYY-MM-DD format
endDate	Date	Filter Results by endDate, it requires a corresponding startDate. Both must be in YYYY-MM-DD format
title	String	Fileter results by VForm Title

Headers

Name	Type	Description
token*	String	API secret token

CWB History Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "Results retrieved",
    "data": {
        "docs": [
            {
                "id": "6388737f79b3176be7eae374",
                "title": "test",
                "entries": 0,
                "allowedEntries": null,
                "createdAt": "2022-12-01T09:27:27.655Z",
                "updatedAt": "2022-12-01T09:27:27.655Z",
                "userId": "62b2e8b381442b75857f7898",
                "businessId": "62b2e8b281442b03187f7896",
                "isHidden": false,
                "status": "draft",
                "templateType": "RegularVFormTemplate",
                "last3Users": [],
                "user": {
                    "firstName": "Abdulazeez",
                    "lastName": "Shittu",
                    "middleName": "",
                    "email": "[email protected]",
                    "mobile": "[phone]",
                    "countryCode": "NG",
                    "id": "62b2e8b381442b75857f7898"
                }
            },
            {
                "id": "6368a5ce75d8197615700ff1",
                "title": "check",
                "entries": 6,
                "allowedEntries": null,
                "createdAt": "2022-11-07T06:29:34.769Z",
                "updatedAt": "2022-11-07T06:29:34.769Z",
                "userId": "62b2e8b381442b75857f7898",
                "businessId": "62b2e8b281442b03187f7896",
                "isHidden": false,
                "status": "published",
                "templateType": "RegularVFormTemplate",
                "last3Users": [
                    {
                        "firstName": "shittu",
                        "lastName": "name"
                    },
                    {
                        "firstName": "test",
                        "lastName": "me"
                    },
                    {
                        "firstName": "me",
                        "lastName": "shittu"
                    }
                ],
                "user": {
                    "firstName": "Abdulazeez",
                    "lastName": "Shittu",
                    "middleName": "",
                    "email": "[email protected]",
                    "mobile": "[phone]",
                    "countryCode": "NG",
                    "id": "62b2e8b381442b75857f7898"
                }
            },
        ],
        "pagination": {
            "totalDocs": 2,
            "perPage": 20,
            "page": 1,
            "totalPages": 1,
            "serialNo": 1,
            "hasPrevPage": false,
            "hasNextPage": false,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1
        }
    },
    "links": []
}

Explanation