List workspaces, or create one with POST. derived from route
URL
- User APIhttps://automations.mattering.io/api/user/v1/workspaces/
- Service tierhttps://automations.mattering.io/api/internal/workspaces/
Query parameters
| Name | Default |
|---|---|
status | active |
Body keys (JSON)
| Key | Required | Default |
|---|---|---|
description | optional or conditional | none |
name | optional or conditional | none |
space_id | optional or conditional | none |
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Responses
200 bare JSON object (no envelope)
{
"id": "...",
"organization_id": "...",
"space_id": "...",
"workspace_public_id": "...",
"name": "...",
"description": "...",
"status": "...",
"created_by_user_id": "...",
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
200 bare JSON object (no envelope)
{
"workspaces": [
{
"id": "...",
"organization_id": "...",
"space_id": "...",
"workspace_public_id": "...",
"name": "...",
"description": "...",
"status": "...",
"created_by_user_id": "...",
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
]
}
201 bare JSON object (no envelope)
{
"id": "...",
"organization_id": "...",
"space_id": "...",
"workspace_public_id": "...",
"name": "...",
"description": "...",
"status": "...",
"created_by_user_id": "...",
"created_at": "2026-01-01T00:00:00Z",
"updated_at": "2026-01-01T00:00:00Z"
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
Errors
| Status | Code |
|---|---|
| 401 | unauthorized |
| 502 | WorkspaceServiceUnavailable message |
Example
curl -X POST "https://automations.mattering.io/api/user/v1/workspaces/" \
-H "Authorization: Bearer $MATTERING_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "...",
"name": "...",
"space_id": "..."
}'curl -X POST "https://automations.mattering.io/api/internal/workspaces/" \
-H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
-H "X-Internal-Org-Id: $ORG_ID" \
-H "X-Internal-User-Email: you@example.com" \
-H "Content-Type: application/json" \
-d '{
"description": "...",
"name": "...",
"space_id": "..."
}'
Source: AutomationsCore/workspaces/views.py (views.workspace_list_or_create)