> ## 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/ja/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>