Sign in
workspaces

List Workspaces

Get all workspaces visible to this auth in the current org. Does not create a new workspace/org.

get/api/v1/workspaces

Query parameters

include_deletedboolean
data_plane_idstring uuid nullable

Response

Successful Response

idstring uuid required
organization_idstring uuid nullable
created_atstring date-time required
display_namestring required
is_personalboolean required
is_deletedboolean required
tenant_handlestring nullable
data_plane_urlstring nullable
read_onlyboolean
role_idstring uuid nullable
role_namestring nullable
permissionsstring[] nullable

Changes

Changed in 2 of the 48 revisions of this API.2

  • a0acb3a6a1011See the full diff
    • ○

      added the new optional query request parameter data_plane_id

      new-optional-request-parameter

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e0b1677609471See the full diff
    • ○

      added the optional property items/data_plane_url to the response with the 200 status

      response-optional-property-added