Skip to content
Artbucket

A brand on BrandHub

GET
/api/v1/brands/{slug}/hub
curl --request GET \
  --url http://localhost:3000/api/v1/brands/example/hub \
  --header 'Authorization: Bearer <token>'

Every published brand is on BrandHub at {org}/{brand}, private by default: its project’s people see it, signed in. Public, anyone and any agent reads its latest publish, as a page, llms.txt, brand.json and design tokens. portals: the portals it could link as its guidelines; null without the right to manage portals.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Brand slug

Responses

Section titled “Responses”

200

Section titled “200”

The brand on BrandHub

Media typeapplication/json
object
data
required
object
visibility
required

Private: the project’s people see it on BrandHub, signed in; public: anyone and any agent

string
Allowed values: private public
url
required

Its page there: BrandHub’s own address when public, the app’s /hub when private

string format: uri
published
required
Any of:
object
number
required
integer
>= -9007199254740991 <= 9007199254740991
publishedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
portal
required
Any of:
object
slug
required
string
name
required
string
chosen
required

That portal was picked; false: it is the brand’s first public portal

boolean
pulls
required

Its BrandHub files (brand.json, llms.txt, tokens) read in the last 30 days, as its BrandHub card shows

integer
>= -9007199254740991 <= 9007199254740991
delisted
required

Taken off BrandHub by whoever runs the server, and why: it can’t be made public until they list it again

string | null
movedTo

Claimed by whoever proved its domain: the listing that took its place, as {org}/{brand}; it can’t be made public again

string | null
ref
required

How BrandHub names it: {org}/{brand}

string
verified
required

What its organization proved it holds, a domain or github.com/{login}; null: a community listing

string | null
terms
required

The terms of use its guidelines portal asks readers to accept, in markdown

string | null
portals
required
Any of:
Array<object>
object
slug
required
string
name
required
string
access
required
string
Allowed values: public password members
url
required
string format: uri
Example
{
  "data": {
    "visibility": "private",
    "portals": [
      {
        "access": "public"
      }
    ]
  }
}

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"
  }
}