Branches

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

List all branches

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

This endpoint allows you to get the list of your branches. The branches are returned, sorted by name (A-Z).

Query Parameters

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

Headers

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

200

{
    "data": [
        {
            "id": 2,
            "name": "Branch 2",
            "status": 1
        },
        {
            "id": 1,
            "name": "Logiciel Actif Inc",
            "status": 1
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 2
    },
    "success": true
}

Retrieve a branch

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

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

Path Parameters

Name	Type	Description
id	string	The ID of the resource to retrieve

Headers

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

200

{
    "data": {
        "id": 1,
        "name": "Logiciel Actif Inc",
        "status": 1
    },
    "success": true
}