Skip to content
Artbucket

Brands, the default first

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

Scope: read.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Brands

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
slug
required
string
name
required
string
default
required
boolean
private
required

Only grants on it, and admins, reach it in the app

boolean
visibility
required

Who sees it on BrandHub

string
Allowed values: private public
from

The BrandHub brand it started from, as {org}/{brand}@{n}

string | null
domain

Its own domain (acme.com): whoever proves it may claim its BrandHub listing

string | null
movedTo

Claimed on BrandHub by whoever proved its domain: the listing that took its place, as {org}/{brand}

string | null
rules
required
integer
>= -9007199254740991 <= 9007199254740991
createdAt
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)))$/
Example
{
  "data": [
    {
      "visibility": "private"
    }
  ]
}

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