> ## Documentation Index > Fetch the complete documentation index at: https://docs.blaxel.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get workspace details > Returns detailed information about a workspace including its display name, account ID, status, and runtime configuration. ## OpenAPI ````yaml /api-reference/controlplane.yml get /workspaces/{workspaceName} openapi: 3.0.3 info: title: Blaxel Control Plane version: 0.0.1 servers: - description: Blaxel Control Plane url: https://api.blaxel.ai/v0 - description: Blaxel Inference url: https://run.blaxel.ai security: - OAuth2: - admin - ApiKeyAuth: [] paths: /workspaces/{workspaceName}: get: tags: - workspaces summary: Get workspace details description: >- Returns detailed information about a workspace including its display name, account ID, status, and runtime configuration. operationId: GetWorkspace parameters: - description: Name of the workspace in: path name: workspaceName required: true schema: type: string - description: >- When true, the response includes a resourceCounts map with the number of agents, functions, models, sandboxes, policies, jobs, volumes, volumetemplates, integrationconnections, previews, customdomains, serviceaccounts and images currently in this workspace. Off by default — each count is one extra indexed query. in: query name: countResources required: false schema: default: false type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/Workspace' description: successful operation '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized - Invalid or missing authentication credentials '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden - You do not have access to this workspace '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not found - Workspace does not exist '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal server error security: - OAuth2: - workspaces:get - ApiKeyAuth: [] components: schemas: Workspace: type: object description: >- Tenant container that groups all Blaxel resources (agents, functions, models, etc.) with shared team access control and billing. allOf: - $ref: '#/components/schemas/TimeFields' - $ref: '#/components/schemas/OwnerFields' - properties: accountId: type: string description: Workspace account id displayName: type: string description: Workspace display name example: My Workspace groupMappings: type: array description: >- Group-to-role mappings for directory sync (SCIM) group membership items: $ref: '#/components/schemas/GroupWorkspaceMapping' id: type: string description: Autogenerated unique workspace id readOnly: true labels: $ref: '#/components/schemas/MetadataLabels' name: type: string description: Workspace name example: my-workspace region: type: string description: Workspace write region example: us-west-2 resourceCounts: type: object description: >- Per-resource counts (agents, functions, models, sandboxes, policies, jobs, volumes, drives, volumetemplates, integrationconnections, previews, customdomains, serviceaccounts, images). Only populated when GetWorkspace is called with ?countResources=true. additionalProperties: type: integer readOnly: true runtime: $ref: '#/components/schemas/WorkspaceRuntime' status: type: string description: >- Workspace status (created, account_binded, account_configured, workspace_configured, ready, error) enum: - created - account_binded - account_configured - workspace_configured - ready - error readOnly: true example: ready statusReason: type: string description: Reason for current status (only set for error status) readOnly: true Error: type: object description: Standard error response returned by the API when a request fails properties: code: type: integer description: HTTP status code of the error example: 409 error: type: string description: Error type or code identifying the kind of error example: Resource already exists message: type: string description: Human-readable error message describing what went wrong example: Invalid request body required: - error TimeFields: type: object description: Time fields for Persistance properties: createdAt: type: string description: The date and time when the resource was created readOnly: true updatedAt: type: string description: The date and time when the resource was updated readOnly: true OwnerFields: type: object description: Owner fields for Persistance properties: createdBy: type: string description: The user or service account who created the resource readOnly: true updatedBy: type: string description: The user or service account who updated the resource readOnly: true GroupWorkspaceMapping: type: object description: Mapping between an IdP group and a workspace role for directory sync properties: groupName: type: string description: Name of the IdP group (e.g. "Engineering", "Platform") example: Engineering role: type: string description: Role to assign in this workspace (admin or member) enum: - admin - member example: admin MetadataLabels: type: object description: >- Key-value pairs for organizing and filtering resources. Labels can be used to categorize resources by environment, project, team, or any custom taxonomy. additionalProperties: type: string WorkspaceRuntime: type: object description: Runtime configuration for the workspace infrastructure properties: generation: type: string description: >- Infrastructure generation version for the workspace (affects available features and deployment behavior) example: mk3 securitySchemes: OAuth2: description: OAuth2 authentication with JWT tokens flows: authorizationCode: authorizationUrl: /oauth/authorize scopes: admin: Administrative access agents:create: Create agents agents:delete: Delete agents agents:get: Get agent details agents:list: List agents agents:update: Update agents apiKey:list: List API keys apiKey:write: Create and delete API keys configurations:list: List configurations customdomains:create: Create custom domains customdomains:delete: Delete custom domains customdomains:get: Get custom domain details customdomains:list: List custom domains customdomains:update: Update custom domains functions:create: Create functions functions:delete: Delete functions functions:get: Get function details functions:list: List functions functions:update: Update functions integrations:create: Create integrations integrations:list: List integrations invitations:list: List invitations jobs:create: Create jobs jobs:delete: Delete jobs jobs:get: Get job details jobs:list: List jobs jobs:update: Update jobs locations:list: List locations mcphub:list: List MCP hub resources models:create: Create models models:delete: Delete models models:get: Get model details models:list: List models models:update: Update models policies:create: Create policies policies:delete: Delete policies policies:get: Get policy details policies:list: List policies policies:update: Update policies sandboxes:control: Control sandbox operations sandboxes:create: Create sandboxes sandboxes:delete: Delete sandboxes sandboxes:get: Get sandbox details sandboxes:list: List sandboxes sandboxes:update: Update sandboxes sandboxhub:list: List sandbox hub resources templates:get: Get template details templates:list: List templates volumeTemplates:create: Create volume templates volumeTemplates:delete: Delete volume templates volumeTemplates:get: Get volume template details volumeTemplates:list: List volume templates volumeTemplates:upsert: Create or update volume templates volumes:create: Create volumes volumes:delete: Delete volumes volumes:get: Get volume details volumes:list: List volumes workspaces:accept: Accept workspace invitation workspaces:create: Create workspaces workspaces:decline: Decline workspace invitation workspaces:delete: Delete workspaces workspaces:get: Get workspace details workspaces:invite: Invite users to workspace workspaces:leave: Leave workspace workspaces:list: List workspaces workspaces:remove: Remove users from workspace workspaces:update: Update workspaces tokenUrl: /oauth/token clientCredentials: scopes: admin: Administrative access agents:create: Create agents agents:delete: Delete agents agents:get: Get agent details agents:list: List agents agents:update: Update agents apiKey:list: List API keys apiKey:write: Create and delete API keys configurations:list: List configurations customdomains:create: Create custom domains customdomains:delete: Delete custom domains customdomains:get: Get custom domain details customdomains:list: List custom domains customdomains:update: Update custom domains functions:create: Create functions functions:delete: Delete functions functions:get: Get function details functions:list: List functions functions:update: Update functions integrations:create: Create integrations integrations:list: List integrations invitations:list: List invitations jobs:create: Create jobs jobs:delete: Delete jobs jobs:get: Get job details jobs:list: List jobs jobs:update: Update jobs locations:list: List locations mcphub:list: List MCP hub resources models:create: Create models models:delete: Delete models models:get: Get model details models:list: List models models:update: Update models policies:create: Create policies policies:delete: Delete policies policies:get: Get policy details policies:list: List policies policies:update: Update policies sandboxes:control: Control sandbox operations sandboxes:create: Create sandboxes sandboxes:delete: Delete sandboxes sandboxes:get: Get sandbox details sandboxes:list: List sandboxes sandboxes:update: Update sandboxes sandboxhub:list: List sandbox hub resources templates:get: Get template details templates:list: List templates volumeTemplates:create: Create volume templates volumeTemplates:delete: Delete volume templates volumeTemplates:get: Get volume template details volumeTemplates:list: List volume templates volumeTemplates:upsert: Create or update volume templates volumes:create: Create volumes volumes:delete: Delete volumes volumes:get: Get volume details volumes:list: List volumes workspaces:accept: Accept workspace invitation workspaces:create: Create workspaces workspaces:decline: Decline workspace invitation workspaces:delete: Delete workspaces workspaces:get: Get workspace details workspaces:invite: Invite users to workspace workspaces:leave: Leave workspace workspaces:list: List workspaces workspaces:remove: Remove users from workspace workspaces:update: Update workspaces tokenUrl: /oauth/token type: oauth2 ApiKeyAuth: bearerFormat: API Key description: Long-lived API key for programmatic access scheme: bearer type: http ````