/v1/workspaces/getWorkspace
—
post
Path Parameters
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Request Body
GetWorkspaceEndpointParams

Parameters for retrieving workspace information. If workspaceId is not provided, returns the current user's default workspace

{
workspaceId?: string
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
GetWorkspaceEndpointResult

Response containing the requested workspace information

{
workspace: Workspace
}
Workspace

A workspace containing files, folders, and access control settings

{
resourceId: string
createdBy: Agent
createdAt: number
lastUpdatedBy: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
workspaceId: string
name: string
rootname: string
description?: string
publicPermissionGroupId: string
billStatusAssignedAt: number
billStatus: string
usageThresholds: WorkspaceUsageThresholds
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
WorkspaceUsageThresholds

Usage thresholds for different resource categories in the workspace

{
storage?: UsageThreshold
storageEver?: UsageThreshold
bin?: UsageThreshold
bout?: UsageThreshold
total?: UsageThreshold
}
UsageThreshold

Usage threshold configuration for workspace billing and limits

{
lastUpdatedBy: Agent
lastUpdatedAt: number
category: string
budget: number
usage: number
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}