Get All Branches

The Get All Branches API allows authorized users to retrieve a list of branch stored in the system.

API Method

GET

Endpoint

https://cebuana-apiuat.veryfyglobal.com/branches

Headers

Key	Value
Accept	application/json
Authorization	Bearer <YOUR_TOKEN>

Query Parameters

Parameter	Type	Required	Description
name	string	No	Filter branches by their name.
address	string	No	Filter branches by their address.
is_active	integer	No	Filter branches based on their active status. Refer ChoiceEnum ID
is_suspend	integer	No	Filter branches based on their suspended status. Refer ChoiceEnum ID

Response Sample

200: Ok

{
    "message": "Ok",
    "data": {
        "records": [
         
            {
                "id": 1,
                "name": "Branch 1",
                "address": "Pedro Gil Mabini",
                "is_active": {
                    "value": 1,
                    "description": "Yes"
                },
                "is_suspend": {
                    "value": 0,
                    "description": "No"
                },
                 "sell_enabled": {
                    "value": 1,
                    "description": "Yes"
                }
            },
            {
                "id": 2,
                "name": "Branch 2",
                "address": "MH Del Pilar",
                "is_active": {
                    "value": 1,
                    "description": "Yes"
                },
                "is_suspend": {
                    "value": 0,
                    "description": "No"
                },
                 "sell_enabled": {
                    "value": 1,
                    "description": "Yes"
                }
            },
            {
                "id": 3,
                "name": "Branch 3",
                "address": "Makati Ave",
                "is_active": {
                    "value": 1,
                    "description": "Yes"
                },
                "is_suspend": {
                    "value": 0,
                    "description": "No"
                },
                 "sell_enabled": {
                    "value": 1,
                    "description": "Yes"
                }
            },
        ],
        "pagination": {
            "current_page": 1,
            "last_page": 1,
            "total_record": 3,
            "page_size": 15,
            "has_more_page": false
        }
    }
}

403: Forbidden

401: Unauthorized