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

# List ad slots

`GET /v1/ad-slots`

## Request

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

List the programmatic ad slots configured in the workspace. Each slot includes its provider, endpoint, venue or device identifiers, and its minimum and maximum duration limits. The exchange credential itself is never included; only the name of the stored credential reference is returned.

**Notes.**
- Newest first; only slots at locations the caller can see. `secretRefs` is always `[]` here: read one slot to see them.

## Response `200`

Success.

- object
  - `data` AdSlot[], required
    - `id` string, required
    - `spaceId` string, required
    - `name` string, required
    - `enabled` boolean, required
    - `nodeId` string, nullable, required: Home location; null = workspace root.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `config` AdSlotConfig, required
      - `provider` 'vast' | 'vistar' | 'broadsign' | 'hivestack', required
      - `endpoint` string, required: The ad server URL (http or https, a public host).
      - `credsRef` string, required: The name of the secret (set with `PUT /v1/ad-slots/:id/secrets`) that holds the ad server credential.
      - `venueId` string, nullable
      - `deviceTypeId` string, nullable
      - `minSeconds` integer, required: Shortest ad to accept, 1–300 (default 5).
      - `maxSeconds` integer, required: Longest ad to accept, at least `minSeconds`.
      - `podSeconds` integer, required: Seconds of ads per break, at least `maxSeconds`.
      - `allowAudio` boolean, required
      - `vistar` object: Vistar settings. Only for `provider` = `vistar`. The endpoint is fixed by `environment`.
        - `environment` 'staging' | 'production', required: Which Vistar network the slot talks to. Staging and production use separate credentials.
        - `spots` integer, required: Open spots requested per visit to the pod, 1–12. Each spot is one request and at most one ad.
        - `staticSeconds` integer, required: Seconds a still image plays, 1–60.
    - `secretRefs` string[], required: Secret names that hold a value. Values are never returned. The single-slot reads fill this; the list answers `[]`.

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