Entries

The entries API lets you retrieve and filter all entries submitted by agents in your organization.

Get Entries

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

Returns a list of all entries in your organisation.

Query Parameters

Name	Type	Description
sortBy	string	createdAt [Default: id]
sortOrder	string	asc | desc [Default: asc]
page	number	[Default: 1]
perPage	number	[Default: 50]
dispatch	string	Id of the entry dispatch
agent	string	Id of the agent
form	string	Id of the entry form
status	string	pending | accepted | rejected
country	string	Country of the entry
project	string	Id of the entry project
state	boolean	State of the entry

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200 Entries successfully retrieved.

{
    "success": true,
    "data": [
        {
            "id": "5efdd95bed83211b2d205139",
            "status": "accepted",
            "dispatch": "5efdd474ea543b18eb4b0b4e",
            "form": "5ef9cef14ba08a2aac9d0a6c",
            "project": "5efd9b5cda30d50b26c49604",
            "agent": "5efdc8210f524412fd1a43f5",
            "location": {
                "address": "11b Oduduwa Cres, Ikeja GRA, Ikeja, Nigeria",
                "country": "NIGERIA",
                "state": "LAGOS",
                "lga": "Ikeja",
                "city": "Ikeja GRA",
                "coordinates": {
                    "longitude": 3.316928544149041,
                    "lattitude": 3.316928544149041
                }
            },
            "answers": [
                {
                    "type": "singleChoice",
                    "question": "What is your Gender?",
                    "answer": "male"
                },
                {
                    "type": "singleChoice",
                    "question": "Do you like animals?",
                    "answer": "yes"
                },
                {
                    "type": "multiChoice",
                    "question": "Select the pets you have",
                    "answer": ['dogs', 'cats']
                }
            ],
            "duration": 10,
            "createdAt": "2020-07-02T12:55:54.605Z",
            "updatedAt": "2020-07-02T15:55:54.605Z"
        },
        ...
    ],
    "_metadata": {
        "total": 100000,
        "perPage": 60,
        "pageCount": 1667,
        "pageLinks": {
            "current": "https://api.databeaver.co/v1/entries?dispatch=5efdd474ea543b18eb4b0b4e&page=10&perPage=60",
            "next": "https://api.databeaver.co/v1/entries?dispatch=5efdd474ea543b18eb4b0b4e&page=11&perPage=60",
            "previous": "https://api.databeaver.co/v1/entries?dispatch=5efdd474ea543b18eb4b0b4e&page=9&perPage=60"
        }
    }
}

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 Entry by Id

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

Returns a single entry.

Path Parameters

Name	Type	Description
id	string	Entry id

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200

{
    "success": true,
    "data": {
        "id": "5efdd95bed83211b2d205139",
        "status": "accepted",
        "dispatch": {
            "id": "5efdd474ea543b18eb4b0b4e",
            "dispatchType": "basic",
            "status": "dispatched",
            "name": "Test Dispatch",
            "totalExpectedEntries": 150000,
            "createdAt": "2020-07-02T12:34:58.718Z",
            "updatedAt": "2020-07-02T12:34:58.718Z"
        },
        "form": {
            "id": "5ef9cef14ba08a2aac9d0a6c",
            "dispatched": true,
            "status": "active",
            "name": "Test Form",
            "reason": "Test",
            "createdAt": "2020-06-29T11:22:24.849Z",
            "updatedAt": "2020-06-29T11:22:24.849Z"
        },
        "project": {
            "id": "5efd9b5cda30d50b26c49604",
            "name": "Test Project",
            "modifiedBy": "5ef9ceb44ba08a2aac99fd2b",
            "createdAt": "2020-07-02T08:31:24.013Z",
            "updatedAt": "2020-07-02T08:31:24.013Z"
        },
        "agent": {
            "id": "5efdc8210f524412fd1a43de",
            "status": "active",
            "firstName": "Test",
            "lastName": "Agent",
            "email": "[e-mail]",
            "phone": "08000000000",
            "location": [
                {
                    "country": "Nigeria",
                    "zone": "South West",
                    "state": "Lagos",
                    "city": "Lagos"
                }
            ],
            "createdAt": "2020-07-02T11:42:24.861Z",
            "updatedAt": "2020-07-02T11:42:24.861Z"
        },
        "location": {
            "address": "11b Oduduwa Cres, Ikeja GRA, Ikeja, Nigeria",
            "country": "NIGERIA",
            "state": "LAGOS",
            "lga": "Ikeja",
            "city": "Ikeja GRA",
            "coordinates": {
                "longitude": 3.316928544149041,
                "lattitude": 3.316928544149041
            }
        },
        "answers": [
            {
                "type": "singleChoice",
                "question": "What is your Gender?",
                "answer": "male"
            },
            {
                "type": "singleChoice",
                "question": "Do you like animals?",
                "answer": "yes"
            },
            {
                "type": "multiChoice",
                "question": "Select the pets you have",
                "answer": ['dogs', 'cats']
            }
        ],
        "duration": 10,
        "createdAt": "2020-07-02T12:55:54.605Z",
        "updatedAt": "2020-07-02T12:55:54.605Z"
    }
}

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

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

404 No entry found with the provided id

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