---
title: "Get branch status on SuperApp"
method: GET
path: "/branches/{branch_id}/visibility/status"
tags: ["Store API endpoints"]
---

# Get branch status on SuperApp

`GET /branches/{branch_id}/visibility/status`

## Request

- Base URL: `https://apigateway.careemdash.com/pos/api/v1`
- URL: `https://apigateway.careemdash.com/pos/api/v1/branches/{branch_id}/visibility/status`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://identity.careem.com/token` scopes: `pos`
- TypeScript: <https://skmtc.dev/careemnow/apis/careem-pos-api/docs/branches/:branch_id/visibility/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Use this endpoint to read a branch's current visibility status on SuperApp.

The `status` reflects the latest known outlet state:
 - `active`: branch is live and accepting orders.
 - `inactive`: branch is temporarily not accepting orders and can be reactivated by the partner.
 - `offline`: branch is not accepting orders and can only be reactivated by Careem operations.

`reason` carries the human-readable reason when the branch is not active (otherwise null). `can_reactivate` is null when not applicable (active), true when the partner can self-reactivate (inactive), and false when only Careem ops can (offline).

## Path parameters

- `branch_id` string, required

## Headers

- `Authorization` string, required
- `User-Agent` string, required
- `Brand-Id` string, required

## Response `200`

Branch status retrieved successfully

- BranchStatusResponse
  - `branch_id` string: The unique branch ID string provided by the vendor or restaurant.
  - `status` 'active' | 'inactive' | 'offline': The current visibility status of the branch on SuperApp.
  - `reason` string, nullable: Human-readable reason the branch is not active. Null when the branch is active.
  - `can_reactivate` boolean, nullable: Null when not applicable (active); true when the partner can self-reactivate (inactive); false when only Careem operations can reactivate (offline).

## Other responses

- `400`: Bad request, or branch is not mapped
- `404`: Either the brand or branch doesn't exist, or status is not yet available for this branch
- `500`: Internal server error

## Changes

- **2026-08-06** `374e3e0dddca`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/careemnow/apis/careem-pos-api/changes/branches/:branch_id/visibility/status/get.md)

---

[API](https://skmtc.dev/careemnow/apis/careem-pos-api.md) - [All operations](https://skmtc.dev/careemnow/apis/careem-pos-api/llms.txt) - [OpenAPI document](https://skmtc.dev/careemnow/apis/careem-pos-api/revisions/1bf0e9d19f04?raw)