Menu

Workspaces

2 endpoints in the Mattering Automations API.

GETPOST workspaces/ User APIService tier

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

NameDefault
statusactive

Body keys (JSON)

KeyRequiredDefault
descriptionoptional or conditionalnone
nameoptional or conditionalnone
space_idoptional or conditionalnone

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

StatusCode
401unauthorized
502WorkspaceServiceUnavailable 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": "..."
}'

Source: AutomationsCore/workspaces/views.py (views.workspace_list_or_create)

GETPATCHDELETE workspaces/{workspace_id}/ User APIService tier

Read, update or delete one of the workspaces by id. derived from route

URL

  • User APIhttps://automations.mattering.io/api/user/v1/workspaces/{workspace_id}/
  • Service tierhttps://automations.mattering.io/api/internal/workspaces/{workspace_id}/

Path parameters

NameType
workspace_idstr

Body keys (JSON)

KeyRequiredDefault
descriptionoptional or conditionalnone
nameoptional or conditionalnone
space_idoptional or conditionalnone
statusoptional or conditionalnone

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"
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401unauthorized
502WorkspaceServiceUnavailable message

Example

curl -X PATCH "https://automations.mattering.io/api/user/v1/workspaces/WORKSPACE_ID/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "...",
  "name": "...",
  "space_id": "...",
  "status": "..."
}'

Source: AutomationsCore/workspaces/views.py (views.workspace_detail)

All Automations resources
Start Free Explore our Products