Skip to main content
Use this endpoint to fetch the full details of a single workspace by its ID. The response includes the workspace’s name, owner, a list of all members with their roles, and all applications currently linked to the workspace.

​
Request

GET https://api.virtuscloud.app/v2/workspaces/{workspaceId}

​
Headers

​
Authorization
string
required
Your Virtus Cloud API key. Pass it directly as the header value — no prefix required.Example: Authorization: vc_live_xxxxxxxxxxxx

​
Path Parameters

​
workspaceId
string
required
The unique identifier of the workspace you want to retrieve.

​
Response

​
status
string
Returns "success" when the request completes successfully.
​
response
object
The full workspace details object.

​
Examples

curl -X GET https://api.virtuscloud.app/v2/workspaces/dcedcd13d7e272a7b32a70f6a1d180f23c12d759 \
  -H "Authorization: <api_key>"

​
Response Example

{
  "status": "success",
  "response": {
    "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
    "name": "Test",
    "owner": "5354d9742d889d49b20134ba0be09ccc0033be68",
    "members": [
      {
        "name": "Example",
        "id": "5354d9742d889d49b20134ba0be09ccc0033be68",
        "group": "owner",
        "joinedAt": "2025-06-04T20:44:55.934Z"
      }
    ],
    "applications": [],
    "createdAt": "2025-06-04T20:44:55.934Z"
  }
}