Returns an ordered, cursor-bounded page of Workspace definitions. Continue with next_cursor using the same purpose and include_archived filters. Each page checks current Workspace authority and the commit-ordered Workspace journal version captured with the prior page. A change returns 409 catalog_changed; restart from page one. Native credentials require exactly one purpose=task query value. Other purposes are browser-only.
Path Parameters
workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
Query Parameters
purpose
string
Values
documentprojecttask
include_archived
boolean·default false
Include retained archived definitions for management surfaces.
cursor
string·min 1·max 2048
Opaque continuation cursor returned by the preceding page.
limit
integer·min 1·max 100·default 50
Maximum number of resources to return.
Responses
itemsRequired
object[]
next_cursor
string·min 1·max 2048
Opaque, endpoint-specific pagination cursor.
has_moreRequired
boolean
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
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
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
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.
