Forms

The forms API lets you retrieve and filter forms created by admins in your organization.

Get Forms

GET https://api.developer.databeaver.co/v1/forms

Returns the list of the all forms in your organisation.

Query Parameters

Name	Type	Description
sortOrder	string	asc | desc [Default: asc]
sortBy	string	createdAt | name | sector [Default: id]
perPage	number	[Default: 50]
page	number	[Default: 1]
dispatched	string	true | false
status	string	active | inactive
name	string	Name of the form
sector	string	Sector of the form

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200 Forms successfully retrieved.

{
    "success": true,
    "data": [
        {
            "id": "5efd9d99f89cee0bf9afbf2d",
            "dispatched": true,
            "status": "active",
            "name": "Test Form",
            "sector": "Biodata",
            "reason": "Test",
            "createdBy": {
                "id": "5ef9ceb44ba08a2aac99fd41",
                "role": {
                    "name": "Owner"
                },
                "status": "active",
                "firstName": "Test",
                "lastName": "Admin",
                "email": "[e-mail]",
                "createdAt": "2020-06-29T11:21:24.304Z",
                "updatedAt": "2020-06-29T11:21:24.304Z",
                "lastLogin": "2020-06-29T11:21:24.304Z"
            },
            "createdAt": "2020-07-02T08:40:24.013Z",
            "updatedAt": "2020-07-02T08:40:24.013Z"
        },
        ...
    ],
    "_metadata": {
        "total": 900002,
        "perPage": 50,
        "pageCount": 18001,
        "pageLinks": {
            "current": "https://api.databeaver.co/v1/forms?status=active&page=3&perPage=50&sortBy=name",
            "next": "https://api.databeaver.co/v1/forms?status=active&page=4&perPage=50&sortBy=name",
            "previous": "https://api.databeaver.co/v1/forms?status=active&page=2&perPage=50&sortBy=name"
        }
    }
}

400 Request could not be processed due to an invalid query parameter.

{
    "success": false,
    "error": "\"perPage\" must be a number"
}

401 Request could not be processed due to a missing or invalid API key.

{
    "success": false,
    "error": "Invalid API key"
}

Get Form By Id

GET https://api.developer.databeaver.co/v1/forms/:id

Returns a single form using the the form id.

Path Parameters

Name	Type	Description
id	string	Form id

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200

{
    "success": true,
    "data": {
        "id": "5efd9d99f89cee0bf9afbf2d",
        "dispatched": true,
        "status": "active",
        "name": "Test Form",
        "sector": "Biodata",
        "reason": "Test",
        "createdBy": {
            "id": "5ef9ceb44ba08a2aac99fd41",
            "role": {
                "name": "Owner"
            },
            "status": "active",
            "firstName": "Test",
            "lastName": "Admin",
            "email": "[e-mail]",
            "createdAt": "2020-06-29T11:21:24.304Z",
            "updatedAt": "2020-06-29T11:21:24.304Z",
            "lastLogin": "2020-06-29T11:21:24.304Z"
        },
        "createdAt": "2020-07-02T08:40:24.013Z",
        "updatedAt": "2020-07-02T08:40:24.013Z"
    }
}

401 Request could not be processed due to a missing or invalid API key.

{
    "success": false,
    "error": "Invalid API key"
}

404 No form found with the provided id

{
    "success": false,
    "error": "No record found with id: 5ef1b5d593d98d0636a56adf"
}