---
title: "List screen groups"
method: GET
path: "/v1/screen-groups"
tags: ["screen-groups"]
---

# List screen groups

`GET /v1/screen-groups`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/screen-groups`
- Auth: HTTP bearer

List the screen groups in your workspace. Each group includes the number of screens in it and the IDs of the screens you have access to see.

## Response `200`

Success.

- object
  - `data` ScreenGroup[], required
    - `id` string, required: Screen group id.
    - `name` string, required
    - `description` string, nullable, required
    - `screenCount` integer, required: Members the caller can see.
    - `screenIds` string[], required: Member screen ids the caller can see, oldest membership first.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).

## 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)