---
title: "Get a screen's up-next schedule"
method: GET
path: "/v1/screens/{id}/up-next"
tags: ["screens"]
---

# Get a screen's up-next schedule

`GET /v1/screens/{id}/up-next`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/screens/{id}/up-next`
- Auth: HTTP bearer

Get the current running order and the next scheduled change for a screen, based on exactly what the screen itself will play. This endpoint is relatively expensive to compute and should be called on demand rather than polled regularly.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` object, required
    - `now` union, required: What is on the glass now; null when nothing is.
      - object
        - `name` string, required
        - `kind` string, required
        - `seconds` number, nullable, required
      - object
        - `name` string, required
        - `kind` 'emergency' | 'cast', required
    - `overriddenBy` object, nullable, required
      - `kind` 'emergency' | 'cast', required
      - `endsAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `rotation` object[], required: The running order under any override, in play order.
      - `name` string, required
      - `kind` string, required
      - `seconds` number, nullable, required: Fixed dwell; null when the item plays for its own length.
    - `loops` boolean, required
    - `nextChange` object, nullable, required
      - `at` string, required: ISO-8601 timestamp (UTC).
      - `what` string, nullable, required
      - `screensOff` boolean, required

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