Workspace
get
Authorizations
Query parameters
filtersstringOptional
Responses
200Success
application/json
403
Forbidden.
get
GET /v1/workspace HTTP/1.1
Host:
x-api-key: YOUR_API_KEY
Accept: */*
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-06-27T21:33:02.968Z",
"updatedAt": "2025-06-27T21:33:02.968Z",
"createdBy": "text",
"blocks": [
"text"
],
"propertyDefinitions": [
"text"
],
"propertyInstances": [
"text"
],
"attachments": [
"text"
],
"statusDefinitions": [
"text"
],
"statusInstances": [
"text"
],
"statusOptions": [
"text"
],
"requirementsPages": [
"text"
],
"requirementBlocks": [
"text"
],
"reports": [
"text"
],
"reportBlocks": [
"text"
],
"attributes": [
"text"
],
"interfaces": [
"text"
],
"bomTables": [
"text"
],
"bomColumns": [
"text"
],
"codeBlocks": [
"text"
],
"codeInputs": [
"text"
],
"codeOutputs": [
"text"
]
}
post
Authorizations
Body
idstringOptionalDefault:
1c8a9171-67a8-45b7-ac2f-1e0b9b0ad9ad
labelstringRequired
publicCanReadEnabledbooleanOptional
currentWorkspaceVersionstringOptionalDefault:
2ed1cc49-a15f-4c61-8d68-e8e0001af62c
exportsEnabledbooleanOptional
guestsEnabledbooleanOptional
statusesstring[]Optional
Responses
201
The record has been successfully created.
application/json
403
Forbidden.
post
POST /v1/workspace HTTP/1.1
Host:
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 216
{
"id": "1c8a9171-67a8-45b7-ac2f-1e0b9b0ad9ad",
"label": "text",
"publicCanReadEnabled": true,
"currentWorkspaceVersion": "2ed1cc49-a15f-4c61-8d68-e8e0001af62c",
"exportsEnabled": true,
"guestsEnabled": true,
"statuses": [
"text"
]
}
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-06-27T21:33:02.968Z",
"updatedAt": "2025-06-27T21:33:02.968Z",
"createdBy": "text",
"blocks": [
"text"
],
"propertyDefinitions": [
"text"
],
"propertyInstances": [
"text"
],
"attachments": [
"text"
],
"statusDefinitions": [
"text"
],
"statusInstances": [
"text"
],
"statusOptions": [
"text"
],
"requirementsPages": [
"text"
],
"requirementBlocks": [
"text"
],
"reports": [
"text"
],
"reportBlocks": [
"text"
],
"attributes": [
"text"
],
"interfaces": [
"text"
],
"bomTables": [
"text"
],
"bomColumns": [
"text"
],
"codeBlocks": [
"text"
],
"codeInputs": [
"text"
],
"codeOutputs": [
"text"
]
}
get
Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
403
Forbidden.
get
GET /v1/workspace/{id} HTTP/1.1
Host:
x-api-key: YOUR_API_KEY
Accept: */*
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-06-27T21:33:02.968Z",
"updatedAt": "2025-06-27T21:33:02.968Z",
"createdBy": "text",
"blocks": [
"text"
],
"propertyDefinitions": [
"text"
],
"propertyInstances": [
"text"
],
"attachments": [
"text"
],
"statusDefinitions": [
"text"
],
"statusInstances": [
"text"
],
"statusOptions": [
"text"
],
"requirementsPages": [
"text"
],
"requirementBlocks": [
"text"
],
"reports": [
"text"
],
"reportBlocks": [
"text"
],
"attributes": [
"text"
],
"interfaces": [
"text"
],
"bomTables": [
"text"
],
"bomColumns": [
"text"
],
"codeBlocks": [
"text"
],
"codeInputs": [
"text"
],
"codeOutputs": [
"text"
]
}
delete
Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
403
Forbidden.
delete
DELETE /v1/workspace/{id} HTTP/1.1
Host:
x-api-key: YOUR_API_KEY
Accept: */*
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-06-27T21:33:02.968Z",
"updatedAt": "2025-06-27T21:33:02.968Z",
"createdBy": "text",
"blocks": [
"text"
],
"propertyDefinitions": [
"text"
],
"propertyInstances": [
"text"
],
"attachments": [
"text"
],
"statusDefinitions": [
"text"
],
"statusInstances": [
"text"
],
"statusOptions": [
"text"
],
"requirementsPages": [
"text"
],
"requirementBlocks": [
"text"
],
"reports": [
"text"
],
"reportBlocks": [
"text"
],
"attributes": [
"text"
],
"interfaces": [
"text"
],
"bomTables": [
"text"
],
"bomColumns": [
"text"
],
"codeBlocks": [
"text"
],
"codeInputs": [
"text"
],
"codeOutputs": [
"text"
]
}
patch
Authorizations
Path parameters
idstringRequired
Body
rootBlockobjectOptional
labelstringOptional
Responses
200Success
application/json
403
Forbidden.
patch
PATCH /v1/workspace/{id} HTTP/1.1
Host:
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"rootBlock": {},
"label": "text"
}
{
"id": "text",
"label": "text",
"rootBlock": "text",
"createdAt": "2025-06-27T21:33:02.968Z",
"updatedAt": "2025-06-27T21:33:02.968Z",
"createdBy": "text",
"blocks": [
"text"
],
"propertyDefinitions": [
"text"
],
"propertyInstances": [
"text"
],
"attachments": [
"text"
],
"statusDefinitions": [
"text"
],
"statusInstances": [
"text"
],
"statusOptions": [
"text"
],
"requirementsPages": [
"text"
],
"requirementBlocks": [
"text"
],
"reports": [
"text"
],
"reportBlocks": [
"text"
],
"attributes": [
"text"
],
"interfaces": [
"text"
],
"bomTables": [
"text"
],
"bomColumns": [
"text"
],
"codeBlocks": [
"text"
],
"codeInputs": [
"text"
],
"codeOutputs": [
"text"
]
}
Was this helpful?