🏬 Get Branches

Endpoint: GET /api/branches

Description: Used to retrieve a list of branches and their status.

Authorization: Required (Authorization: Bearer \<token>)

🧾 Response POS

βœ… Success

{
  "branches": [
    {
      "id": "122",
      "name": "Downtown Branch",
      "status": true,
      "brand_id": "5000",
      "location": "Downtown City"
    }
  ]
}

πŸ—‚ Field Descriptions

FieldTypeDescription
branchesarrayList of all brand branches
branches[].idstringUnique identifier for the branch
branches[].namestringBranch name (e.g., "Downtown Branch")
branches[].statusboolean1 if open/available, 0 if paused/unavailable
branches[].brand_idstringThe ID of the brand this branch belongs to
branches[].locationstringHuman-readable address or description

🧠 Behavior

  • Blend calls this endpoint to fetch the list of branches


What’s Next