Authoring Workspace Access API

Notebook, Pipeline Authoring, and Transform Authoring workspaces share the same visibility and direct grant model. The resource-specific workspace APIs expose the shared access DTOs at each product's workspace path.

info

All endpoints are mounted under /api/v1.0. Paths below omit that prefix for readability.

Visibility

Value	Meaning
`space`	Everyone with access to the space can view the workspace.
`private`	Only the owner and space administrators can view the workspace.
`shared`	The owner, space administrators, and explicitly granted users or teams can view the workspace.

Grants

Field	Values
`principal_type`	`user` or `team`
`principal_id`	UUID of the user or team
`access_level`	`view` or `manage`

view permits workspace visibility. manage permits workspace configuration and sharing changes.

Access Endpoints

Product	Read	Replace
Notebooks	`GET /engagement/spaces/{space_slug}/notebooks/workspaces/{workspace_id}/access`	`PUT /engagement/spaces/{space_slug}/notebooks/workspaces/{workspace_id}/access`
Pipeline Authoring	`GET /spaces/{space_slug}/pipeline-authoring/workspaces/{workspace_id}/access`	`PUT /spaces/{space_slug}/pipeline-authoring/workspaces/{workspace_id}/access`
Transform Authoring	`GET /spaces/{space_slug}/transform-authoring/workspaces/{workspace_id}/access`	`PUT /spaces/{space_slug}/transform-authoring/workspaces/{workspace_id}/access`

The update operation replaces the visibility, owner, and grants as one settings document. Send the full intended grant list.

Update Access Settings

{
  "visibility": "shared",
  "owner_user_id": "owner-user-uuid",
  "grants": [
    {
      "principal_type": "team",
      "principal_id": "team-uuid",
      "access_level": "view"
    },
    {
      "principal_type": "user",
      "principal_id": "user-uuid",
      "access_level": "manage"
    }
  ]
}

Access Settings Response

{
  "workspace_id": "workspace-uuid",
  "visibility": "shared",
  "owner_user_id": "owner-user-uuid",
  "grants": [
    {
      "id": "grant-uuid",
      "principal_type": "team",
      "principal_id": "team-uuid",
      "access_level": "view",
      "principal": {
        "id": "team-uuid",
        "name": "Analytics Engineering",
        "slug": "analytics-engineering"
      },
      "created_at": "2026-06-22T08:00:00Z",
      "updated_at": "2026-06-22T08:00:00Z"
    }
  ],
  "effective_permissions": {
    "can_view": true,
    "can_manage": true
  }
}

Workspace Create And Update Fields

Workspace create and update payloads for Notebooks, Pipeline Authoring, and Transform Authoring include these shared fields:

Field	Description
`visibility`	`space`, `private`, or `shared`.
`owner_user_id`	Optional owner override where supported.
`authoring_query_connector_ids`	Optional list of query connector UUIDs allowed for authoring previews or execution.

Error Notes

Status	Meaning
`400`	Payload is invalid or references unsupported grants.
`403`	The user cannot manage the workspace.
`404`	Workspace, user, team, or connector was not found in the space.

Visibility​

Grants​

Access Endpoints​

Update Access Settings​

Access Settings Response​

Workspace Create And Update Fields​

Error Notes​

Related​