---
title: "Get playlist share readiness"
method: GET
path: "/v1/playlists/{id}/share-readiness"
tags: ["playlists"]
---

# Get playlist share readiness

`GET /v1/playlists/{id}/share-readiness`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/playlists/{id}/share-readiness`
- Auth: HTTP bearer

For a playlist's airtime reserved for other teams, list who at each location can fill their share, and the narrowest role that would let them do so.

**Notes.**
- `requiredPermissions` is absent when `locations` is empty.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` object, required
    - `locations` object[], required: One per location that holds a percent share of this playlist.
      - `nodeId` string, required
      - `nodeName` string, required
      - `canFill` boolean, required: Somebody at the location can fill the share now.
      - `fillerCount` integer, required
      - `candidates` object[], required: People at the location who cannot fill it yet.
        - `userId` string, required
        - `name` string, required
        - `email` string, required
      - `roleId` string, nullable, required: The narrowest existing role that would let them fill it.
      - `roleName` string, nullable, required
      - `mayGrant` boolean, required: The caller may give that role at that location.
      - `fillApprovalState` 'draft' | 'pending' | 'approved' | 'rejected', nullable, required: Where the location's own content stands in review; null when nothing is added yet.
      - `requiresApproval` boolean, required: The owner checks this location's content before it airs.
    - `requiredPermissions` string[]: The permissions filling a share needs. Absent when no location holds a share.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No such playlist in this workspace.
- `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)