Skip to content

What is shared into this project

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

Brands, collections and assets other projects of the organization shared into this one: each as it is at home, sharedFrom naming it.

Scope: read.

Shared objects

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)$/
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
sharedFrom
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)$/
name
required
string
Example
{
"data": [
{
"type": "brand",
"status": "draft",
"parent": {
"type": "brand"
}
}
]
}

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"detail": "example"
}
}