Skip to content
Artbucket

The files a brand uses

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

Its rules’ files, in the rules’ order, then the ones its pages show (a cover, an image, a video, a file), each with the rules and pages it is in. Only what the caller may see.

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”

Its files

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)$/
title
required
string
filename
required
string
mime
required
string
width
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
height
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
preview
required

Has renditions: /a/{id}/w_320,f_webp draws it

boolean
rules
required

The keys of the rules that hold it

Array<string>
pages
required

The pages that show it

Array<object>
object
slug
required
string
title
required
string
Examplegenerated
{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "title": "example",
      "filename": "example",
      "mime": "example",
      "width": 1,
      "height": 1,
      "preview": true,
      "rules": [
        "example"
      ],
      "pages": [
        {
          "slug": "example",
          "title": "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"
  }
}