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

# List screenshots

`GET /v1/screenshots`

## Request

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

List screen captures uploaded by your screens. Filter by a specific screen using the `screenId` query parameter. The image bytes for each screenshot are retrieved separately from GET /v1/screenshots/:id/file.

## Query parameters

- `screenId` string

## Response `200`

Success.

- object
  - `data` object[], required
    - `id` string, required
    - `screenId` string, required
    - `screenName` string, required
    - `url` string, required: Download path (GET /v1/screenshots/{id}/file).
    - `capturedAt` string, required: ISO-8601 timestamp (UTC).
    - `confirmedAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `width` integer, nullable, required
    - `height` integer, nullable, required
    - `sourceWidth` integer, nullable, required
    - `sourceHeight` integer, nullable, required
    - `sizeBytes` integer, required
    - `capturedBy` 'agent' | 'projection' | 'accessibility' | 'webview', nullable, required
    - `belowNative` boolean: Present and true when the capture is smaller than the panel's native resolution.

## 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/7c2741bcdb16?raw)