---
title: "Count screens by status"
method: GET
path: "/v1/screens/count-by-status"
tags: ["screens"]
---

# Count screens by status

`GET /v1/screens/count-by-status`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/screens/count-by-status`
- Auth: HTTP bearer

Get a count of screens by status: online, offline, and unpaired. Counts are limited to the organization nodes you can see.

**Notes.**
- Returns the counts at the top level — NOT wrapped in `{ data }` like other routes.

## Response `200`

Success.

- object
  - `online` integer, required
  - `offline` integer, required
  - `degraded` integer, required: Always 0 today (reserved).
  - `unpaired` integer, required: Screens in `pairing` status.
  - `obstructed` integer, required: Online screens with a system dialog covering them (also counted in `online`).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)