Get a workspace

GET/v1/workspaces/{slug}

Get a workspace.

Requires access to the workspace: an organization owner or admin, a member of the workspace, an organization-scoped va_ key with the admin role, or a va_ key scoped to this workspace. Errors: 403 without access; 404 when the organization has no workspace with this slug.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

slugstringrequired
the workspace's slug

Query parameters

organizationstringrequired
the slug of the organization the workspace belongs to

Responses

200application/json

idstring<uuid>
The workspace's id (UUID), used as workspace_id elsewhere in the API.
organizationstring
The slug of the organization the workspace belongs to.
slugstring
The workspace's slug, unique within the organization, used in workspace URLs.
namestring
The workspace's display name.
descriptionstring
A description of the workspace; absent when none was given.
default_routing_config_slugstring
The routing config the dashboard selects by default for this workspace; absent when none is set.
created_atstring<date-time>
When the workspace was created (ISO 8601 date-time).
updated_atstring<date-time>
When the workspace was last changed (ISO 8601 date-time).

VectorAxis is built by GK Labs, a member of NVIDIA Inception.