Skip to main content

Workspaces API

Version: 1.0

Get workspace

GET
/workspace/orgs/{org_id}/workspaces/{workspace_id}

Returns a workspace by its ID, provided your user has a role to access it. To retrieve a workspace by ID regardless of your user role, see the 'Admin' equivalent API.

Request

Path parameters
org_iduuid
Required
workspace_iduuid
Required
Query parameters

Only list workspaces that have been deleted.

Responses

200

Successful Response

bounding_boxobject | null
created_atdate-time
emailstring | null
iduuid
namestring | null
current_user_role"owner" | "editor" | "viewer"
default_coordinate_systemstring
descriptionstring
iduuid
labelsstring[]
Default: []
ml_enabledboolean

The name of the workspace, unique within an organization and hub

self_linkuri
updated_atdate-time
emailstring | null
iduuid
namestring | null

401

No permission -- see authorization schemes

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring

403

Request forbidden -- authorization will not help

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring

404

Resource not found or user lacks access

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring

405

Specified method is invalid for this resource

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring

410

Resource is gone

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring

422

Unprocessable Entity

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring

© Seequent, The Bentley Subsurface Company