---
title: "Get a creative's overrides at a location"
method: GET
path: "/v1/creative-overrides/{creativeId}"
tags: ["creative-overrides"]
---

# Get a creative's overrides at a location

`GET /v1/creative-overrides/{creativeId}`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/creative-overrides/{creativeId}`
- Auth: HTTP bearer

Return the edits a location has made to a creative that was shared with it, the merged result of applying those edits, and any edits that have stopped applying.

## Path parameters

- `creativeId` string, required

## Query parameters

- `node` string

## Response `200`

Success.

- object
  - `data` object, required
    - `creativeId` string, required
    - `nodeId` string, required: The location the edits apply at.
    - `values` object, required: The location's edits: box id → the box fields it changes (for example `{ "price": { "text": "13.00" } }`).
    - `overrideId` string, nullable, required: Id of the stored edits (what an approval request is opened against); null before the first save.
    - `approvalState` 'draft' | 'pending' | 'approved' | 'rejected', required: Review state of the edits (not of the design).
    - `requiresApproval` boolean, required: The location requires approval before the edits air.
    - `skipsApproval` boolean, required: The author waived that review for this design.
    - `creative` OverrideCreative, required: A creative's design: the boxes and scenes with their settings.
      - `id` string, required
      - `nodeId` string, nullable, required
      - `name` string, required
      - `backgroundUrl` string, nullable, required
      - `boxes` object[], required
      - `scenes` object[], required
      - `dataSourceId` string, nullable, required
      - `stage` string: Absent when not set.
      - `shareLockDefault` unknown, required
      - `shareEditsSkipApproval` boolean, required
      - `stageWidth` integer
      - `stageHeight` integer
      - `touchEnabled` boolean
      - `approvalState` 'draft' | 'pending' | 'approved' | 'rejected', required: Review state. Editing an approved row returns it to `draft`.
      - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `orphanedBoxIds` string[], required: Edited box ids the design no longer has.
    - `sharedFrom` string, nullable, required: The workspace that owns the design, when it was shared in from another workspace.
    - `base` OverrideCreative, required: A creative's design: the boxes and scenes with their settings.
      - `id` string, required
      - `nodeId` string, nullable, required
      - `name` string, required
      - `backgroundUrl` string, nullable, required
      - `boxes` object[], required
      - `scenes` object[], required
      - `dataSourceId` string, nullable, required
      - `stage` string: Absent when not set.
      - `shareLockDefault` unknown, required
      - `shareEditsSkipApproval` boolean, required
      - `stageWidth` integer
      - `stageHeight` integer
      - `touchEnabled` boolean
      - `approvalState` 'draft' | 'pending' | 'approved' | 'rejected', required: Review state. Editing an approved row returns it to `draft`.
      - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `rejectedFields` string[], required: `boxId.field` edits that no longer apply because the author locked the field.
    - `updatedAt` string, nullable, required: ISO-8601 timestamp (UTC).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: Unknown location, no such creative, or the creative is not usable at that location.
- `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)
