Skip to main content
GET
Describe a catalog object

Authorizations

Authorization
string
header
required

An API key: ab_...

Path Parameters

ref
string
required

An id, or an address

Response

The object

id
string<uuid>
required
Pattern: ^([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
enum<string>
required
Available options:
brand,
collection,
asset,
portal,
rule,
page
slug
string
required
name
string
required
address
string
required

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

description
string | null
required
status
enum<string>
required
Available options:
draft,
in_review,
current,
replaced,
archived
release
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
expires
string | null
required
expiring
boolean
required
private
boolean
required
tags
string[]
required
project
object
required
parent
object | null
required
createdAt
string
required
updatedAt
string
required
usedBy
object[]
required
usedByCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
lineage
object
required
sharedWith
object[]
required
open
string
required

Where the app shows it