Skip to content
Artbucket

Read a domain's brand.json

GET
/api/v1/brand-json
curl --request GET \
  --url http://localhost:3000/api/v1/brand-json \
  --header 'Authorization: Bearer <token>'

What POST /brands with domain would make, before making it: each brand the domain’s AdCP brand.json holds (a house portfolio’s, its brand_refs read at their own domains), with its colors, faces, logo count and what has no place in the rules, and the one picked when no brand is named.

Scope: write.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
domain
string

A domain, e.g. acme.com

Responses

Section titled “Responses”

200

Section titled “200”

What it holds

Media typeapplication/json
object
data
required
object
domain
required
string | null
pick
required

The brand POST /brands makes when brand is left out; null: name one

string | null
brands
required
Array<object>
object
id
required

Its AdCP id: POST /brands takes it as brand

string
name
required
string
slug
required
string
domain
required
string | null
tagline
required
string | null
colors
required
Array<string>
fonts
required
Array<string>
logos
required
integer
>= -9007199254740991 <= 9007199254740991
rules
required
integer
>= -9007199254740991 <= 9007199254740991
files
required
integer
>= -9007199254740991 <= 9007199254740991
dropped
required
Array<string>
skipped
required
Array<string>
Examplegenerated
{
  "data": {
    "domain": "example",
    "pick": "example",
    "brands": [
      {
        "id": "example",
        "name": "example",
        "slug": "example",
        "domain": "example",
        "tagline": "example",
        "colors": [
          "example"
        ],
        "fonts": [
          "example"
        ],
        "logos": 1,
        "rules": 1,
        "files": 1,
        "dropped": [
          "example"
        ]
      }
    ],
    "skipped": [
      "example"
    ]
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}