Retrieve CWB Responses

This endpoint returns a list of responses for a specific vForm templateId.

GET {{baseurl}}/v2/api/v-forms/:templateId/responses

Path Parameters

Name	Type	Description
templateId*	String	template id

Query Parameters

Name	Type	Description
page	Number	Page number for 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
verificationId	String	Get a response by Verification Id
status	String	Filter responses by status which can be cleared, not_cleared, pending, review_required, and pending_payment

Headers

Name	Type	Description
token*	String	API secret token

CWB Responses Sample Response

{
    "success": true,
    "statusCode": 200,
    "message": "Results retrieved",
    "data": {
        "docs": [
            {
                "_id": "6391dbfd3c70fd9bc72871af",
                "ipAddress": null,
                "status": "cleared",
                "createdAt": "2022-12-08T12:43:42.087Z",
                "firstName": "shittu",
                "lastName": "name",
                "photo": null
            },
            {
                "_id": "6391db312a5d2e9a5d916eb0",
                "ipAddress": null,
                "status": "cleared",
                "createdAt": "2022-12-08T12:40:18.370Z",
                "firstName": "test",
                "lastName": "me",
                "photo": null
            },
            {
                "_id": "6389c75079b317a51eeae48c",
                "ipAddress": null,
                "status": "cleared",
                "createdAt": "2022-12-02T09:37:20.610Z",
                "firstName": "me",
                "lastName": "shittu",
                "photo": null
            },
        ],
        "pagination": {
            "totalDocs": 3,
            "limit": 20,
            "page": 1,
            "totalPages": 1,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": false,
            "prevPage": null,
            "nextPage": null,
            "currentPage": 1,
            "perPage": 20,
            "serialNo": 1
        }
    },
    "links": []
}

Explanation

Attribute	Type	Description
_id	String	vForm's object unique identifier.
ipAddress	String	This is the form filler's ipAddress.
firstname	String	This form filler's firstname
lastname	String	This form filler's lastname
createdAt	String(date)	The date this response was submitted.
status	String	This is the overall status of this response which can be anyone of the following "pending": This is the overall status of a response when there is/are still a/some verification(s) to be done on the response or when some responses are still expected from a reference form. "cleared": This is the overall status of the response when a form with no verification has been submitted or when all the verifications and validations have been performed by vform on a response and are all passed "not_cleared": This is the overall status of the response when one or more of the verifications and validations performed by vform on a response failed. "pending_payment":