Skip to main content

Branch

Branch List​

Use this API to list all branches.

 GET /branch/branch-list

Query string parameters​

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned from the first record Default: 20, Max count limit: 100
qstringfilter data by branch name
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "branchList": [
                    {
                        "branchId": 7,
                        "name": "West",
                        "status": true,
                        "parentBranchId": 0
                    }                    
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}