> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取 Workspace

> 获取 workspace 信息。

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  你账户的 API 密钥。你可以在[账户设置](https://squarecloud.app/zh/account/security)中找到它。
</ParamField>

### 参数

<ParamField path="workspaceId" type="string" placeholder="Workspace Id">
  workspace 的 ID。
</ParamField>

### 响应

<ResponseField name="status" type="string">
  指示调用是否成功。成功时为 `success`，否则为 `error`。
</ResponseField>

<ResponseField name="response" type="object">
  响应的内容。

  <Expandable title="展开对象">
    <ResponseField name="id" type="string">
      Workspace 的 ID。
    </ResponseField>

    <ResponseField name="owner" type="string">
      Workspace 拥有者的 ID。
    </ResponseField>

    <ResponseField name="name" type="string">
      Workspace 的名称。
    </ResponseField>

    <ResponseField name="members" type="object">
      workspace 成员列表。

      <Expandable title="展开对象">
        <ResponseField name="id" type="string">
          用户的 ID。
        </ResponseField>

        <ResponseField name="name" type="string">
          用户的名称。
        </ResponseField>

        <ResponseField name="group" type="string">
          该成员对 workspace 应用的权限。
        </ResponseField>

        <ResponseField name="joinedAt" type="string">
          加入时间戳（UTC-0）。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="applications" type="object">
      workspace 应用列表。

      <Expandable title="展开对象">
        <ResponseField name="id" type="string">
          已上传应用的 ID。
        </ResponseField>

        <ResponseField name="name" type="string">
          已上传应用的名称。
        </ResponseField>

        <ResponseField name="ram" type="number">
          已上传应用的 RAM 使用量（单位 MB）。
        </ResponseField>

        <ResponseField name="language" type="object">
          已上传应用的编程语言。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      创建时间戳（UTC-0）。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "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"
    }
  }
  ```
</ResponseExample>