Agent

The agents API lets you retrieve and filter agents in your organization.

Get Agents

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

Returns a list of all agents 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]
city	string	City of the agent
firstName	string	First name of the agent
lastName	string	Last name of the agent
status	string	active | inactive
country	string	Country of the agent
zone	string	Zone of the agent
state	boolean	state of

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200 Agents successfully retrieved.

{
    "success": true,
    "data": [
        {
            "id": "5efdcc869b03541646256fec",
            "groups": [],
            "status": "active",
            "firstName": "Test",
            "lastName": "Agent",
            "email": "[e-mail]",
            "phone": "08000000000",
            "location": [
                {
                    "country": "Nigeria",
                    "zone": "South West",
                    "state": "Lagos",
                    "city": "Lagos"
                }
            ],
            "createdAt": "2020-07-02T12:00:40.183Z",
            "updatedAt": "2020-07-02T12:00:40.183Z"
        },
        ...
    ],
    "_metadata": {
        "total": 1103012,
        "perPage": 10,
        "pageCount": 110302,
        "pageLinks": {
            "current": "https://api.databeaver.co/v1/agents?perPage=10&sortOrder=desc&page=1",
            "next": "https://api.databeaver.co/v1/agents?perPage=10&sortOrder=desc&page=2"
        }
    }
}

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

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

Returns a single agent.

Path Parameters

Name	Type	Description
id	string	Agent id

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200

{
    "success": true,
    "data": {
        "id": "5efdcc869b03541646256fec",
        "groups": [],
        "status": "active",
        "firstName": "Test",
        "lastName": "Agent",
        "email": "[e-mail]",
        "phone": "08000000000",
        "location": [
            {
                "country": "Nigeria",
                "zone": "South West",
                "state": "Lagos",
                "city": "Lagos"
            }
        ],
        "createdAt": "2020-07-02T12:00:40.183Z",
        "updatedAt": "2020-07-02T12:00:40.183Z"
    }
}

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

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

404 No agent found with the provided id

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