Projects

This page includes all endpoints available for the projects module of Logiciel Actif.

List all projects

GET https://app.gem-books.com/api/projects

This endpoint allows you to get the list of your projects. The projects are returned sorted by creation date.

Query Parameters

Name	Type	Description
page	integer	The number of the page you wish to see. Default is 1.
per_page	integer	The number of the desired result per page. Default is 20. Maximum values is 100.

Headers

Name	Type	Description
Authentication	string	Bearer token.
Accept	string	Should be application/json.

200

{
    "data": [
        {
            "id": 73,
            "code": null,
            "client_id": 0,
            "active": 1,
            "nom": "Test Project",
            "description": null,
            "tasks": []
        },
        {
            "id": 72,
            "code": null,
            "client_id": 0,
            "active": 1,
            "nom": "Test Project 2",
            "description": null,
            "tasks": []
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 2
    },
    "success": true
}

Retrieve a project

GET https://app.gem-books.com/api/projects/:id

This endpoint allows you to get the details of the project.

Path Parameters

Name	Type	Description
id	integer	The ID of the project to retrieve.

Headers

Name	Type	Description
Authentication	string	Bearer token.
Accept	string	Should be application/json.

200

{
    "data": {
        "id": 73,
        "code": null,
        "client_id": 0,
        "active": 1,
        "nom": "Test Project",
        "description": null,
        "tasks": []
    },
    "success": true
}

Create a project

POST https://app.gem-books.com/api/projects

This endpoint allows you to create a project. Returns the created project.

Headers

Name	Type	Description
Authentication	string	Bearer token.
Content-Type	string	Should be application/json.
Accept	string	Should be application/json.

Request Body

Name	Type	Description
name	string	Project name.

200

{
    "data": {
        "id": 73,
        "code": null,
        "client_id": 0,
        "active": 1,
        "nom": "Test Project",
        "description": null,
        "tasks": []
    },
    "success": true
}

{
    "name": "Test Project"
}

Update a project

PUT https://app.gem-books.com/api/projects/:id

This endpoint allows you to update a specific project. Returns the updated project.

Path Parameters

Name	Type	Description
id	integer	Project id to update

Headers

Name	Type	Description
Authentication	string	Bearer token.
Content-Type	string	Should be application/json.
Accept	string	Should be application/json.

200

{
    "data": {
        "id": 73,
        "code": null,
        "client_id": 0,
        "active": 1,
        "nom": "Test Project",
        "description": null,
        "tasks": []
    },
    "success": true
}

{
    "name": "Test Project"
}