---
title: "ワークスペースリストの照会"
slug: "maiu-list-workspaces"
updated: 2026-09-17T09:58:08Z
published: 2026-09-17T09:58:08Z
canonical: "api.ncloud-docs.com/maiu-list-workspaces"
---

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

# ワークスペースリストの照会

VPC環境で利用できます。

アカウント内ワークスペースリストを照会します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /api/v1/workspaces |

### リクエストヘッダ

Media Intelligence APIで共通して使用されるヘッダの詳細は、[Media Intelligenceのリクエストヘッダ](/docs/ja/maiu-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

パラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `pageNum` | Integer | Required | 照会するページ番号 |
| `pageSize` | Integer | Optional | ページごとの照会項目数 - 1~1,000 - デフォルト: 1,000 |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces?pageNum=1&pageSize=100' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `code` | String | Required | [API処理結果コード](/docs/ja/maiu-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C) |
| `message` | String | Required | [API処理結果メッセージ](/docs/ja/maiu-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C) |
| `result` | Object | Required | APIリターン情報 |
| `result.totalCount` | Integer | Required | 総ワークスペース数 |
| `result.totalPage` | Integer | Required | ページの総数 |
| `result.pageNo` | Integer | Required | リクエストしたページ番号 |
| `result.pageSize` | Integer | Required | リクエストしたページサイズ |
| `result.content` | Array | Required | [ワークスペースリスト](/docs/ja/maiu-list-workspaces#resultcontent) |

#### result.content

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `workspaceName` | String | Required | ワークスペース名 |
| `workspaceUrl` | String | Required | ワークスペース URL |
| `bucketName` | String | Optional | 連携された Object Storageバケット名 |
| `createdUserName` | String | Required | 作成者名 |
| `createdTime` | String | Required | 作成日時 - ISO 8601形式 |
| `updatedUserName` | String | Required | 更新者名 |
| `updatedTime` | String | Required | 更新日時 - ISO 8601形式 |

### レスポンスステータスコード

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、[Media Intelligenceのレスポンスステータスコード](/docs/ja/maiu-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "code": "0",
    "message": "success",
    "result": {
        "totalCount": 2,
        "totalPage": 1,
        "pageNo": 1,
        "pageSize": 100,
        "content": [
            {
                "workspaceName": "my-workspace",
                "workspaceUrl": "https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace",
                "bucketName": "my-bucket",
                "createdUserName": "user123",
                "createdTime": "2026-03-18T10:30:00",
                "updatedUserName": "user123",
                "updatedTime": "2026-03-18T10:30:00"
            },
            {
                "workspaceName": "test-workspace",
                "workspaceUrl": "https://mi.apigw.ntruss.com/api/v1/workspaces/test-workspace",
                "bucketName": "test-bucket",
                "createdUserName": "user456",
                "createdTime": "2026-03-17T09:00:00",
                "updatedUserName": "user456",
                "updatedTime": "2026-03-17T09:00:00"
            }
        ]
    }
}
```