Skip to content
Artbucket

A brand as files

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

Brand as code: the brand as YAML for a Git repository. brand.yaml (slug, name, theme, the order of rules/, the page tree), rules/{group}.yaml (the rules whose key starts with the group), pages/{slug}.yaml (a page’s fields and sections). Every default is left out, so the same brand is always the same bytes. Assets the repository holds are named by path under assets/, the rest by id; assets=files gives every asset a path, to fetch from assets[path].url and add beside the files.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Brand slug

Query Parameters

Section titled “Query Parameters”
assets
string
Allowed values: ids files

Files: every asset as a file under assets/

Responses

Section titled “Responses”

200

Section titled “200”

The files

Media typeapplication/json
object
data
required
object
brand
required
string
files
required
object
key
additional properties
string
assets
required

Each path under assets/ the files name, with its asset: fetch it from url, or compare by sha256

object
key
additional properties
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)$/
filename
required
string
mime
required
string
size
required
integer
>= -9007199254740991 <= 9007199254740991
sha256
required
string
url
required
string format: uri
source
required
Any of:
object
remote
required
string
branch
required
string
path
required
string
commit
required
string | null
syncedAt
required
Any of:
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)))$/
pending
required

Changed here since the repository last agreed: an export is due

boolean
files
required

Assets that are files in the repository

integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "data": {
    "brand": "example",
    "files": {
      "additionalProperty": "example"
    },
    "assets": {
      "additionalProperty": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "filename": "example",
        "mime": "example",
        "size": 1,
        "sha256": "example",
        "url": "https://example.com"
      }
    },
    "source": {
      "remote": "example",
      "branch": "example",
      "path": "example",
      "commit": "example",
      "syncedAt": "2026-04-15T12:00:00Z",
      "pending": true,
      "files": 1
    }
  }
}

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