Skip to content
Artbucket

Search the catalog

GET
/api/v1/catalog
curl --request GET \
  --url 'http://localhost:3000/api/v1/catalog?type=brand&status=draft&limit=30' \
  --header 'Authorization: Bearer <token>'

Every type at once, in every project of the organization you reach: assets, collections, brands, portals, and brands’ rules and pages. q takes free words and the filters inline (logo status:current type:asset); each filter is also a parameter. Counts per type and project; replaced, archived and expired matches are counted in hidden unless status asks for them.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string

Free words and inline filters

type
string
Allowed values: brand collection asset site rule page component

Repeat for several

project
string

A project’s slug

status
string
Allowed values: draft in_review current replaced archived

Repeat for several

tag
string

Carrying this tag

uses
string

Only what is downstream of this address or id

usedby
string

Only what is upstream of this address or id

admin
string

me: what you hold Admin on directly

limit
integer
default: 30 >= 1 <= 100

Page size

cursor
integer

The previous page’s next

Responses

Section titled “Responses”

200

Section titled “200”

Results

Media typeapplication/json
object
query
required
string
total
required
integer
>= -9007199254740991 <= 9007199254740991
counts
required
object
key
additional properties
integer
>= -9007199254740991 <= 9007199254740991
projects
required
Array<object>
object
slug
required
string
name
required
string
count
required
integer
>= -9007199254740991 <= 9007199254740991
items
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)$/
type
required
string
Allowed values: brand collection asset site rule page component
slug
required
string
name
required
string
address
required

{org}/{project}/{type}/{slug}[@release]; a part after its object

string
description
required
string | null
status
required
string
Allowed values: draft in_review current replaced archived
release
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
expires
required
string | null
expiring
required
boolean
private
required
boolean
tags
required
Array<string>
project
required
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
parent
required
Any of:
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)$/
type
required
string
Allowed values: brand collection asset site rule page component
slug
required
string
name
required
string
createdAt
required
string
updatedAt
required
string
hidden
required
object
count
required
integer
>= -9007199254740991 <= 9007199254740991
example
required
string | null
next
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "items": [
    {
      "type": "brand",
      "status": "draft",
      "parent": {
        "type": "brand"
      }
    }
  ]
}

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