Returns current or archived metadata in the active Workspace. Private Project access is required for Project-scoped definitions. Native credential admission is not included.
Path Parameters
label_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
Responses
idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
workspace_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
purposeRequired
string
Values
documentprojecttask
scopeRequired
string
Values
workspaceproject
project_id
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
nameRequired
string·min 1·max 80
colorRequired
string·max 11
Shared user-chosen color: a Tailwind color family name, optionally pinned to one Tailwind step (for example amber or amber-400). A bare name lets each client choose the shade for its surface; a pinned step renders that exact shade.
Exampleindigo
revisionRequired
integer·min 1
created_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
updated_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
archived_at
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
