Workspaces
Workspaces and their settings.
On this page
- getList workspaces/workspaces
- postCreate workspace/workspaces
- deleteDelete workspace/workspaces/{workspaceId}
- getGet workspace/workspaces/{workspaceId}
- patchRename workspace/workspaces/{workspaceId}
- patchUpdate hub settings/workspaces/{workspaceId}/hub-settings
- getList deleted workspaces/workspaces/deleted
List workspaces
Lists workspaces the signed-in user can access in the current tenant.
Technical details
Exact HTTP method and path your client calls
/workspacesHeaders
| Name | Type | Required | Description |
|---|---|---|---|
| X-Workspace-ID | string | optional | Target workspace when the API key is tenant-wide or to disambiguate scope. |
Responses
Workspaces the current account belongs to (membership-scoped, not full tenant list)
| Field | Type | Description |
|---|---|---|
| Workspace[] | ||
| object |
[
{
"id": "string",
"tenantId": "string",
"name": "string",
"slug": "string",
"isDefault": false,
"hubLinkCheckSchedule": "daily"
}
]Errors return the standard envelope. See error reference.
Code samples
curl --request GET \
--url 'https://api.not24get.me/workspaces' \
--header 'Authorization: Bearer <your-api-key>' \
--header 'Content-Type: application/json'Try it
Create workspace
Creates a new workspace with an initial name and optional hub settings.
Technical details
Exact HTTP method and path your client calls
/workspacesHeaders
| Name | Type | Required | Description |
|---|---|---|---|
| X-Workspace-ID | string | optional | Target workspace when the API key is tenant-wide or to disambiguate scope. |
Request body
| Field | Type | Description |
|---|---|---|
| namerequired | string | |
| slug | string |
Responses
Workspace created; creator receives admin membership
| Field | Type | Description |
|---|---|---|
| id | string | |
| tenantId | string | |
| name | string | |
| slug | string | |
| isDefault | boolean | |
| hubLinkCheckSchedule | string | enum: dailyweeklyon_demand |
{
"id": "string",
"tenantId": "string",
"name": "string",
"slug": "string",
"isDefault": false,
"hubLinkCheckSchedule": "daily"
}Errors return the standard envelope. See error reference.
Code samples
curl --request POST \
--url 'https://api.not24get.me/workspaces' \
--header 'Authorization: Bearer <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "string",
"slug": "string"
}'Try it
Delete workspace
Soft-deletes a workspace and its contents. Returns no body on success.
Technical details
Exact HTTP method and path your client calls
/workspaces/{workspaceId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | required |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| X-Workspace-ID | string | optional | Target workspace when the API key is tenant-wide or to disambiguate scope. |
Responses
No Content
| Field | Type | Description |
|---|---|---|
| (value) | EmptyResponsePart |
nullErrors return the standard envelope. See error reference.
Code samples
curl --request DELETE \
--url 'https://api.not24get.me/workspaces/%3AworkspaceId' \
--header 'Authorization: Bearer <your-api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-ID: <workspace-id>'Try it
Get workspace
Returns workspace metadata including hub settings.
Technical details
Exact HTTP method and path your client calls
/workspaces/{workspaceId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | required |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| X-Workspace-ID | string | optional | Target workspace when the API key is tenant-wide or to disambiguate scope. |
Responses
Workspace the current account belongs to
| Field | Type | Description |
|---|---|---|
| id | string | |
| tenantId | string | |
| name | string | |
| slug | string | |
| isDefault | boolean | |
| hubLinkCheckSchedule | string | enum: dailyweeklyon_demand |
{
"id": "string",
"tenantId": "string",
"name": "string",
"slug": "string",
"isDefault": false,
"hubLinkCheckSchedule": "daily"
}Errors return the standard envelope. See error reference.
Code samples
curl --request GET \
--url 'https://api.not24get.me/workspaces/%3AworkspaceId' \
--header 'Authorization: Bearer <your-api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-ID: <workspace-id>'Try it
Rename workspace
Updates the workspace display name.
Technical details
Exact HTTP method and path your client calls
/workspaces/{workspaceId}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | required |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| X-Workspace-ID | string | optional | Target workspace when the API key is tenant-wide or to disambiguate scope. |
Request body
| Field | Type | Description |
|---|---|---|
| namerequired | string |
Responses
Rename workspace
| Field | Type | Description |
|---|---|---|
| id | string | |
| tenantId | string | |
| name | string | |
| slug | string | |
| isDefault | boolean | |
| hubLinkCheckSchedule | string | enum: dailyweeklyon_demand |
{
"id": "string",
"tenantId": "string",
"name": "string",
"slug": "string",
"isDefault": false,
"hubLinkCheckSchedule": "daily"
}Errors return the standard envelope. See error reference.
Code samples
curl --request PATCH \
--url 'https://api.not24get.me/workspaces/%3AworkspaceId' \
--header 'Authorization: Bearer <your-api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-ID: <workspace-id>' \
--data '{
"name": "string"
}'Try it
Update hub settings
Updates workspace hub layout and scheduling preferences.
Technical details
Exact HTTP method and path your client calls
/workspaces/{workspaceId}/hub-settingsPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | required |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| X-Workspace-ID | string | optional | Target workspace when the API key is tenant-wide or to disambiguate scope. |
Request body
| Field | Type | Description |
|---|---|---|
| hubLinkCheckSchedule | string | enum: dailyweeklyon_demand |
Responses
Update SL-378 hub preferences for a workspace
| Field | Type | Description |
|---|---|---|
| id | string | |
| tenantId | string | |
| name | string | |
| slug | string | |
| isDefault | boolean | |
| hubLinkCheckSchedule | string | enum: dailyweeklyon_demand |
{
"id": "string",
"tenantId": "string",
"name": "string",
"slug": "string",
"isDefault": false,
"hubLinkCheckSchedule": "daily"
}Errors return the standard envelope. See error reference.
Code samples
curl --request PATCH \
--url 'https://api.not24get.me/workspaces/%3AworkspaceId/hub-settings' \
--header 'Authorization: Bearer <your-api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-ID: <workspace-id>' \
--data '{
"hubLinkCheckSchedule": "daily"
}'Try it
List deleted workspaces
Lists soft-deleted workspaces that can still be restored.
Technical details
Exact HTTP method and path your client calls
/workspaces/deletedHeaders
| Name | Type | Required | Description |
|---|---|---|---|
| X-Workspace-ID | string | optional | Target workspace when the API key is tenant-wide or to disambiguate scope. |
Responses
Soft-deleted workspaces in the tenant (admin only, SL-24)
| Field | Type | Description |
|---|---|---|
| DeletedWorkspaceSummary[] | ||
| object |
[
{
"id": "string",
"name": "string",
"slug": "string",
"deletedAt": "2026-01-01T00:00:00.000Z",
"daysUntilPermanentDeletion": 0
}
]Errors return the standard envelope. See error reference.
Code samples
curl --request GET \
--url 'https://api.not24get.me/workspaces/deleted' \
--header 'Authorization: Bearer <your-api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Workspace-ID: <workspace-id>'