curl --request GET \ --url 'https://app.output.rocks/api/spa/brand-options?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5BdisplayName%5D=asc&order%5Bpriority%5D=asc&order%5Bcolor%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \ --header 'X-AUTH-TOKEN: <api-key>'

[ { "id": 123, "identifier": "", "displayName": "", "condition": "true", "color": "#083E5D", "priority": 1, "ciCheckEnabled": false, "ciSettings": [ "string" ], "layoutPath": "string", "layoutFileName": "Example name", "layoutChecksum": "string", "layoutInspection": [ "string" ], "layoutFile": "data:application/docx;base64,UEsDBBQABg...", "removeLayout": false, "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "client": {}, "subClient": {}, "active": true, "activeFrom": "2024-01-01", "versionGroup": "123e4567-e89b-12d3-a456-426614174000", "versionNumber": 1, "supersededAt": "2024-08-23T00:00:00+00:00", "changeSummaryDe": "string", "changeSummaryEn": "string", "summaryStatus": "pending", "hasLayout": true, "layoutWarningCount": 1, "default": true, "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D" } ]

SPA Brands

SPA: Retrieves tenant-scoped Brand options

GET/api/spa/brand-options

SPA: Retrieves tenant-scoped Brand options

curl --request GET \
  --url 'https://app.output.rocks/api/spa/brand-options?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5BdisplayName%5D=asc&order%5Bpriority%5D=asc&order%5Bcolor%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "identifier": "",
    "displayName": "",
    "condition": "true",
    "color": "#083E5D",
    "priority": 1,
    "ciCheckEnabled": false,
    "ciSettings": [
      "string"
    ],
    "layoutPath": "string",
    "layoutFileName": "Example name",
    "layoutChecksum": "string",
    "layoutInspection": [
      "string"
    ],
    "layoutFile": "data:application/docx;base64,UEsDBBQABg...",
    "removeLayout": false,
    "createdBy": "user1@company.com",
    "updatedBy": "user1@company.com",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "client": {},
    "subClient": {},
    "active": true,
    "activeFrom": "2024-01-01",
    "versionGroup": "123e4567-e89b-12d3-a456-426614174000",
    "versionNumber": 1,
    "supersededAt": "2024-08-23T00:00:00+00:00",
    "changeSummaryDe": "string",
    "changeSummaryEn": "string",
    "summaryStatus": "pending",
    "hasLayout": true,
    "layoutWarningCount": 1,
    "default": true,
    "subClientId": 3,
    "subClientDescription": "Branch Office A",
    "subClientColor": "#083E5D"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[identifier]

stringdefault:asc

No description provided.

order[displayName]

stringdefault:asc

No description provided.

order[priority]

stringdefault:asc

No description provided.

order[color]

stringdefault:asc

No description provided.

order[activeFrom]

stringdefault:asc

No description provided.

order[active]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

identifier

string

No description provided.

displayName

string

No description provided.

subClient

string

No description provided.

subClient[]

string[]

No description provided.

string

Search across multiple fields (id, identifier, displayName, priority, color, active, activeFrom, subClient.description) using OR logic with partial matching.

active

boolean

No description provided.

activeFrom[before]

string

No description provided.

activeFrom[strictly_before]

string

No description provided.

activeFrom[after]

string

No description provided.

activeFrom[strictly_after]

string

No description provided.

Response

200application/json

Brand collection

integer

identifier

stringrequired

Example: ""

displayName

stringrequired

Example: ""

condition

stringrequired

Example: "true"

color

stringrequired

Example: "#083E5D"

priority

integer

Example: 1

ciCheckEnabled

boolean

Available options: truefalse

Example: false

ciSettings

string | null[] | null

layoutPath

string | null

Storage path of the brand's document layout ("Briefbogen") inside the Tornado template store. Null means the brand has no layout and renders exactly as it does today.

layoutFileName

string | null

Name the file was uploaded under, for the download and the UI.

layoutChecksum

string | null

layoutInspection

string | null[] | null

Result of the upload preflight - fonts, styles, headers, page geometry and the reserved content reference. Shown next to the upload, never used for rendering.

layoutFile

string<binary>

base64 encoded document layout (.docx)

Example: "data:application/docx;base64,UEsDBBQABg..."

removeLayout

boolean

Explicit removal, because a merge-patch cannot distinguish "absent" from "clear".

Available options: truefalse

Example: false

createdBy

string

User, created this entry

Example: "user1@company.com"

updatedBy

string

User, updated this entry

Example: "user1@company.com"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

client

object

subClient

object

active

boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom

string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

versionGroup

string<uuid>

Immutable lineage key shared by all versions of this configuration entry.

versionNumber

integer

Monotonic version counter within the version group. Display/audit only, not part of resolution.

Example: 1

supersededAt

string<date-time>

Moment from which this version is superseded by a newer version of the same version group. Null while the version is (or is scheduled to become) the current one.

changeSummaryDe

string

AI generated German summary of the changes introduced by this version.

changeSummaryEn

string

AI generated English summary of the changes introduced by this version.

summaryStatus

enum<string>

Generation status of the AI change summary.

Available options: pendingdonefailed

hasLayout

boolean

Available options: truefalse

layoutWarningCount

integer

The list needs to show whether a layout has findings, but not the findings themselves - the inspection carries the full design report and would bloat every list response.

default

boolean

Available options: truefalse

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"

subClientColor

string

SubClient display colour. Provided on instances with enabled sub-client module only.

Example: "#083E5D"