Workspaces API

List workspaces

GET

/workspace/orgs/{org_id}/workspaces

Returns a paginated list of all workspaces that you have a role to access in your organization. For a list of all workspaces regardless of your user role, see the 'Admin' equivalent API.

Request

Path parameters

org_iduuid

Required

Query parameters

limitinteger | null

Default: 20

The maximum number of results to return. Limits over 100 are deprecated and may only work for some clients.

offsetinteger | null

The (zero-based) offset of the first item returned in the collection.

sortstring | null

Deprecated

An optional comma separated list of fields to sort the results by. Options are: name, -name, created_at, -created_at, updated_at, -updated_at, user_role, -user_role.

order_bystring | null

An optional, comma-separated list of fields by which to order the results. Each field could be prefixed with an order operator: asc: for ascending order or desc: for descending order, default is ascending order. The sortable fields are: name, created_at, updated_at, and user_role. You can also do compound sorts by comma separating your order params, e.g. asc:user_role,desc:name. This will sort by user_role in ascending order and then by name in descending order as a secondary sort.

filter[created_by]uuid | null

Filter by workspace that a user has created, by user ID.

created_atstring | null

Filter by the time workspace has created.

updated_atstring | null

Filter by the latest time workspace was updated.

filter[name]string | null

Deprecated

Filter by workspace name.

namestring | null

Filter by workspace name.

deletedboolean | null

Include workspaces that have been deleted.

filter[user_id]uuid | null

Filter by workspaces that a user ID has access to.

Responses

200

Successful Response

Response schema

linksPaginationLinks

countinteger

firsturi

(1, 2,083) chars

lasturi

(1, 2,083) chars

nexturi | null

(1, 2,083) chars

previousuri | null

(1, 2,083) chars

totalinteger

resultsWorkspaceRoleRequiredResponse[] | WorkspaceRoleOptionalResponse[]

Any of:

array

bounding_boxBoundingBox | null

created_atdate-time

created_byUserModel

Optional

emailstring | null

iduuid

namestring | null

current_user_role"owner" | "editor" | "viewer"

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

Optional

emailstring | null

iduuid

namestring | null

array

bounding_boxBoundingBox | null

created_atdate-time

created_byUserModel

Optional

emailstring | null

iduuid

namestring | null

current_user_role"owner" | "editor" | "viewer" | 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

Optional

emailstring | null

iduuid

namestring | null

Example response

{
  "links": {
    "count": 0,
    "first": "https://example.com",
    "last": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com",
    "total": 0
  },
  "results": [
    {
      "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": "https://example.com",
      "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-paramsErrorInvalidParam[] | 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-paramsErrorInvalidParam[] | 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-paramsErrorInvalidParam[] | 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-paramsErrorInvalidParam[] | 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-paramsErrorInvalidParam[] | null

statusinteger

titlestring

typestring

Example response

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