Projects

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

Get Projects

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

Returns a list of all projects in your organisation.

Query Parameters

Name	Type	Description
sortOrder	string	asc | desc [Default: asc]
sortBy	string	createdAt | name [Default: id]
perPage	number	[Default: 1]
page	number	[Default: 50]
name	string	Name of the project

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200 Projects retrieved successfully.

{
    "success": true,
    "data": [
        {
            "id": "5efd9b5cda30d50b26c495dd",
            "dispatches": [
                {
                    "id": "5efd9b5cda30d50b26c495e6"
                },
                {
                    "id": "5efd9b5cda30d50b26c495de"
                }
            ],
            "name": "Test Project",
            "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"
            },
            "modifiedBy": {
                "id": "5ef9ceb44ba08a2aac99fd3d",
                "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:31:24.013Z",
            "updatedAt": "2020-07-02T08:31:24.013Z"
        },
        ...
    ],
    "_metadata": {
        "total": 850004,
        "perPage": 10,
        "pageCount": 85001,
        "pageLinks": {
            "current": "https://api.databeaver.co/v1/projects?page=2&perPage=10",
            "next": "https://api.databeaver.co/v1/projects?page=3&perPage=10",
            "previous": "https://api.databeaver.co/v1/projects?page=1&perPage=10"
        }
    }
}

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 Project By Id

GET https://api.databeaver.co/v1/projects/:id

Returns a single project using the project id.

Path Parameters

Name	Type	Description
id	string	Project id

Headers

Name	Type	Description
Authorization	string	Bearer API_KEY

200 Request was successful

{
    "success": true,
    "data": {
        "id": "5efd9b5cda30d50b26c495dd",
        "dispatches": [
            {
                "id": "5efd9b5cda30d50b26c495e6"
            },
            {
                "id": "5efd9b5cda30d50b26c495de"
            }
        ],
        "name": "Test Project",
        "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"
        },
        "modifiedBy": {
            "id": "5ef9ceb44ba08a2aac99fd3d",
            "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:31:24.013Z",
        "updatedAt": "2020-07-02T08:31:24.013Z"
    }
}

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

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

404 No project found with the provided id

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