Skip to main content
GET
/
api
/
v1
/
workspaces
/
{workspace_id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "is_personal": true,
  "is_deleted": true,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_handle": "<string>",
  "data_plane_url": "<string>",
  "read_only": false,
  "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role_name": "<string>",
  "permissions": [
    "<string>"
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Path Parameters

workspace_id
string<uuid>
required

Query Parameters

include_deleted
boolean
default:false
data_plane_id
string<uuid> | null

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
display_name
string
required
is_personal
boolean
required
is_deleted
boolean
required
organization_id
string<uuid> | null
tenant_handle
string | null
data_plane_url
string | null
read_only
boolean
default:false
deprecated
role_id
string<uuid> | null
role_name
string | null
permissions
string[] | null