Skip to content

Every kind that declares workspace lineage, counted in the workspace and sorted by kind; a capped count is a floor (501 when the census is not wired)

GET
/v1/workspaces/{id}/contents
curl --request GET \
--url https://example.com/v1/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contents \
--header 'Authorization: Bearer <token>'

Counts every kind that declares workspace lineage in the workspace, sorted by kind; a kind joins by declaring lineage in its descriptor, with no handler code. A capped count is a floor. 501 when no store census is wired.

id
required
string format: uuid

Resource identifier (UUIDv7).

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

OK

Media type application/json
object
kinds
required
Array<object>
object
capped
required

Count is a floor (“at least Count”), never a total.

boolean
count
required
integer
kind
required
string
workspace_id
required
string format: uuid
Example generated
{
"kinds": [
{
"capped": true,
"count": 1,
"kind": "example"
}
],
"workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}