Skip to main content
GET
Get Workspace

Authorizations

Authorization
string
header
required

An API key or OAuth2/OIDC access token sent as Authorization: Bearer <token>.

Path Parameters

workspace_id
string
required

Response

Successful Response

The singleton SQL data environment owned by an organization.

Connectors and catalogs are direct child resources. Catalogs without a relational source own schemas, and schemas without one own tables. Any mutation to the defaults or an owned child advances revision.

name
string
required

Resource name in the form workspaces/{workspace}.

Pattern: ^workspaces/[a-z0-9](?:[a-z0-9._~-]*[a-z0-9])?$
sqlDefaults
SqlDefaults · object
required

SQL defaults applied before constructing a query session.

revision
string
default:0

Monotonically increasing version of the complete workspace state.

createTime
string | null

Time at which the workspace was created.

updateTime
string | null

Time at which the workspace was most recently updated.