Workspaces API

Get workspace

GET

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

Get a workspace by its ID. Admin endpoints allow organization admin users to access any workspace, regardless of their role or lack thereof within the workspace.

Request

Path parameters

org_iduuid

Required

workspace_iduuid

Required

Query parameters

deletedboolean

Only list workspaces that have been deleted.

Responses

200

Successful Response

Response schema

bounding_boxBoundingBox | null

created_atdate-time

created_byUserModel

emailstring | null

iduuid

namestring | null

current_user_rolestring | null

default_coordinate_systemstring

descriptionstring

iduuid

labelsstring[]

Default: []

ml_enabledboolean

namestring

(1, 60) chars

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

self_linkuri

(1, 2,083) chars

updated_atdate-time

updated_byUserModel

emailstring | null

iduuid

namestring | null

Example response

{
  "bounding_box": {
    "coordinates": [
      [
        [
          0,
          0
        ]
      ]
    ],
    "type": "Polygon"
  },
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "current_user_role": "owner",
  "default_coordinate_system": "string",
  "description": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "labels": [
    "string"
  ],
  "ml_enabled": false,
  "name": "string",
  "self_link": "string",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "updated_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  }
}

401

No permission -- see authorization schemes

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

403

Request forbidden -- authorization will not help

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

404

Resource not found or user lacks access

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

405

Specified method is invalid for this resource

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

410

Resource is gone

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

422

Unprocessable Content

Response schema

detailstring | null

invalid-paramsarray | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}