Skip to content
Artbucket

Describe a catalog object

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

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string

An id, or an address

Responses

Section titled “Responses”

200

Section titled “200”

The object

Media typeapplication/json
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
usedBy
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
usedByCount
required
integer
>= -9007199254740991 <= 9007199254740991
lineage
required
object
up
required
integer
>= -9007199254740991 <= 9007199254740991
down
required
integer
>= -9007199254740991 <= 9007199254740991
sharedWith
required
Array<object>
object
grant
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)$/
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
role
required
string
open
required

Where the app shows it

string
Example
{
  "type": "brand",
  "status": "draft",
  "parent": {
    "type": "brand"
  },
  "usedBy": [
    {
      "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"
  }
}