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

# List creatives

`GET /v1/creatives`

## Request

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

Return the workspace's canvas creatives, including each one's name, stage size, location, and sharing state. The full layout of shapes is not included; use the get-creative operation to retrieve that.

## Query parameters

- `limit` integer
- `cursor` string
- `count` '1'
- `usableAt` string

## Response `200`

Success.

- object
  - `data` Creative[], required
    - `id` string, required: Creative id.
    - `spaceId` string, required
    - `name` string, required
    - `backgroundUrl` string, nullable, required
    - `boxes` object[], required: The design's boxes (text, image, data-bound fields…), in paint order.
    - `dataSourceId` string, nullable, required: The data source the boxes bind to, if any.
    - `stage` string, nullable, required: Stage preset name.
    - `stageWidth` integer, nullable, required
    - `stageHeight` integer, nullable, required
    - `scenes` object[], required: Scenes, for a multi-scene design; often empty.
    - `touchEnabled` boolean, nullable, required
    - `pauseWhileUsed` boolean, nullable, required: Hold the playlist while something a tap opened is up. Null = true.
    - `nodeId` string, nullable, required
    - `approvalState` 'draft' | 'pending' | 'approved' | 'rejected', required: Review state. Editing an approved row returns it to `draft`.
    - `approvedSnapshot` string, nullable, required: JSON TEXT of the last approved version (not parsed).
    - `sourceSignage` unknown, required
    - `look` unknown, required
    - `masterId` string, nullable, required: The master template id, for a design made from one.
    - `shareLockDefault` unknown, required
    - `shareEditsSkipApproval` boolean, required
    - `templateSource` unknown, required
    - `recalledAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `recalledBy` string, nullable, required
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).
  - `nextCursor` string, nullable: Present when `?limit` was passed. Send it back as `?cursor=` for the next page; null on the last page.
  - `total` integer: Total matching rows, when the route computes it.

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