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

# List Knowledge Bases

> Call this API to retrieve the list of DingTalk Docs Knowledge Bases accessible to the operator identified by unionId.

Call this API to retrieve the list of Knowledge Bases based on the operator's unionId.

## Request

### Basic information

| Field               | Value                                                                                        |
| ------------------- | -------------------------------------------------------------------------------------------- |
| HTTP URL            | [https://api.dingtalk.io/v2.0/wiki/workspaces](https://api.dingtalk.io/v2.0/wiki/workspaces) |
| HTTP Method         | GET                                                                                          |
| Supported app types | appType-Internal app　appType-Third-party enterprise app                                      |
| Required permission | permission-Wiki.Workspace.Read-Knowledge Base read permission                                |

### Request headers

| Name                        | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| --------------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential for calling this API. Obtain it as follows:   - For an internal app, call the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app#) API. - For a third-party enterprise app, call the [Get the access token of an organization authorized to a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API. |

### Query parameters

| Name               | Type    | Required | Description                                                                                                                                                                                                                              |
| ------------------ | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nextToken          | String  | No       | The pagination cursor. Leave it empty for the first request.                                                                                                                                                                             |
| maxResults         | Integer | No       | The page size. Default is 30. Maximum is 30.                                                                                                                                                                                             |
| orderBy            | String  | No       | The sort order. Enum values:   - **VIEW\_TIME\_DESC**: Sort by view time in descending order. - **CREATE\_TIME\_DESC**: Sort by created time in descending order. - **MODIFIED\_TIME\_DESC**: Sort by modified time in descending order. |
| withPermissionRole | Boolean | No       | Whether to also query permissions:   - true: Query. - false: Do not query.   Default is false.                                                                                                                                           |
| operatorId         | String  | Yes      | The operator's unionId.                                                                                                                                                                                                                  |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
GET /v2.0/wiki/workspaces?nextToken=next_token&maxResults=30&orderBy=VIEW_TIME_DESC&withPermissionRole=false&operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with the Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkwiki_2_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkwiki_2_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkwiki_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesHeaders listWorkspacesHeaders = new com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesHeaders();
        listWorkspacesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesRequest listWorkspacesRequest = new com.aliyun.dingtalkwiki_2_0.models.ListWorkspacesRequest()
                .setNextToken("next_token")
                .setMaxResults(30)
                .setOrderBy("VIEW_TIME_DESC")
                .setWithPermissionRole(false)
                .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE");
        try {
            client.listWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains code and message properties, which help diagnose the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err contains code and message properties, which help diagnose the issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_dingtalk.wiki_2_0.client import Client as dingtalkwiki_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.wiki_2_0 import models as dingtalkwiki__2__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkwiki_2_0Client:
        """
        Initialize the account Client with the Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkwiki_2_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_workspaces_headers = dingtalkwiki__2__0_models.ListWorkspacesHeaders()
        list_workspaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_workspaces_request = dingtalkwiki__2__0_models.ListWorkspacesRequest(
            next_token='next_token',
            max_results=30,
            order_by='VIEW_TIME_DESC',
            with_permission_role=False,
            operator_id='tXguN309iPhE4roSKPlLURAiEiE'
        )
        try:
            client.list_workspaces_with_options(list_workspaces_request, list_workspaces_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains code and message properties, which help diagnose the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_workspaces_headers = dingtalkwiki__2__0_models.ListWorkspacesHeaders()
        list_workspaces_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_workspaces_request = dingtalkwiki__2__0_models.ListWorkspacesRequest(
            next_token='next_token',
            max_results=30,
            order_by='VIEW_TIME_DESC',
            with_permission_role=False,
            operator_id='tXguN309iPhE4roSKPlLURAiEiE'
        )
        try:
            await client.list_workspaces_with_options_async(list_workspaces_request, list_workspaces_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err contains code and message properties, which help diagnose the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\ListWorkspacesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vwiki_2_0\Models\ListWorkspacesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with the Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $listWorkspacesHeaders = new ListWorkspacesHeaders([]);
        $listWorkspacesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listWorkspacesRequest = new ListWorkspacesRequest([
            "nextToken" => "next_token",
            "maxResults" => 30,
            "orderBy" => "VIEW_TIME_DESC",
            "withPermissionRole" => false,
            "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE"
        ]);
        try {
            $client->listWorkspacesWithOptions($listWorkspacesRequest, $listWorkspacesHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // The err contains code and message properties, which help diagnose the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkwiki_2_0  "github.com/alibabacloud-go/dingtalk/wiki_2_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client with the Token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkwiki_2_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkwiki_2_0.Client{}
  _result, _err = dingtalkwiki_2_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  listWorkspacesHeaders := &dingtalkwiki_2_0.ListWorkspacesHeaders{}
  listWorkspacesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listWorkspacesRequest := &dingtalkwiki_2_0.ListWorkspacesRequest{
    NextToken: tea.String("next_token"),
    MaxResults: tea.Int32(30),
    OrderBy: tea.String("VIEW_TIME_DESC"),
    WithPermissionRole: tea.Bool(false),
    OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // The err contains code and message properties, which help diagnose the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkwiki_2_0 = require('@alicloud/dingtalk/wiki_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client with the Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkwiki_2_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let listWorkspacesHeaders = new dingtalkwiki_2_0.ListWorkspacesHeaders({ });
    listWorkspacesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let listWorkspacesRequest = new dingtalkwiki_2_0.ListWorkspacesRequest({
      nextToken: 'next_token',
      maxResults: 30,
      orderBy: 'VIEW_TIME_DESC',
      withPermissionRole: false,
      operatorId: 'tXguN309iPhE4roSKPlLURAiEiE',
    });
    try {
      await client.listWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err contains code and message properties, which help diagnose the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client with the Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkwiki_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkwiki_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListWorkspacesHeaders listWorkspacesHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListWorkspacesHeaders();
            listWorkspacesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListWorkspacesRequest listWorkspacesRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.ListWorkspacesRequest
            {
                NextToken = "next_token",
                MaxResults = 30,
                OrderBy = "VIEW_TIME_DESC",
                WithPermissionRole = false,
                OperatorId = "tXguN309iPhE4roSKPlLURAiEiE",
            };
            try
            {
                client.ListWorkspacesWithOptions(listWorkspacesRequest, listWorkspacesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains code and message properties, which help diagnose the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err contains code and message properties, which help diagnose the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name           | Type   | Description                                                                                                                                                                                                                                         |
| -------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workspaces     | Array  | The list of Knowledge Bases. Maximum size is 30.                                                                                                                                                                                                    |
| workspaceId    | String | The Knowledge Base ID (spaceUuid).                                                                                                                                                                                                                  |
| corpId         | String | The organization ID that owns the Knowledge Base.                                                                                                                                                                                                   |
| teamId         | String | The ID of the Knowledge Group that owns the Knowledge Base. Returns empty when not owned by any Knowledge Group.                                                                                                                                    |
| rootNodeId     | String | The root node ID (root dentryUuid).                                                                                                                                                                                                                 |
| name           | String | The name of the Knowledge Base.                                                                                                                                                                                                                     |
| type           | String | The type of the Knowledge Base. Enum values:   - **TEAM**: Knowledge Base. - **PERSONAL**: My Docs.                                                                                                                                                 |
| description    | String | The description of the Knowledge Base.                                                                                                                                                                                                              |
| url            | String | The access URL of the Knowledge Base.                                                                                                                                                                                                               |
| icon           | Object | The icon of the Knowledge Base.                                                                                                                                                                                                                     |
| type           | String | The icon type. Enum values:   - **URL**: Link. - **EMOJI**: Emoji icon.                                                                                                                                                                             |
| value          | String | The icon value:   - When type is URL, returns the icon link. - When type is EMOJI, returns the unicode value of the emoji icon.                                                                                                                     |
| cover          | String | The cover URL of the Knowledge Base.                                                                                                                                                                                                                |
| creatorId      | String | The userId of the Knowledge Base creator.                                                                                                                                                                                                           |
| modifierId     | String | The userId of the Knowledge Base modifier.                                                                                                                                                                                                          |
| createTime     | String | The created time of the Knowledge Base.                                                                                                                                                                                                             |
| modifiedTime   | String | The modified time of the Knowledge Base.                                                                                                                                                                                                            |
| permissionRole | String | The permission role of the requester on the Knowledge Base. Enum values:   - **OWNER**: Owner. - **MANAGER**: Manager. - **EDITOR**: Editor. - **DOWNLOADER**: Viewer with download permission. - **READER**: View-only. - **NONE**: No permission. |
| nextToken      | String | The pagination cursor. A non-empty value indicates that more data is available.                                                                                                                                                                     |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "workspaces" : [ {
    "workspaceId" : "By8jQS1ZYjGn5b0M",
    "corpId" : "ding16b241fd05********288",
    "rootNodeId" : "ZgpG2NdyVXXjrKKzIBqMp5zkVMwvDqPk",
    "name" : "workspace_name",
    "type" : "TEAM",
    "description" : "workspace_description",
    "url" : "workspace_url",
    "icon" : {
      "type" : "URL",
      "value" : "icon_url"
    },
    "cover" : "https://example/file-manage-files/zh-CN/202***13/ldet/XXXX.jpg",
    "creatorId" : "workspace_creator_id",
    "modifierId" : "workspace_modifier_id",
    "createTime" : "2023-05-15T11:29Z",
    "modifiedTime" : "2023-05-15T11:29Z",
    "permissionRole" : "READER"
  } ],
  "nextToken" : "next_token"
}
```

### Error codes

If an error is returned when you call this API, find the solution in the [Global error codes](/open/development/server-api-error-codes-1) document based on the error message.

| HttpCode | Error code         | Error message | Description                                                       |
| -------- | ------------------ | ------------- | ----------------------------------------------------------------- |
| 400      | paramError         | %s            | Parameter error.                                                  |
| 400      | paramError.orderBy | %s            | Parameter error - orderBy.                                        |
| 403      | permissionDenied   | %s            | The current user does not have permission to perform this action. |
| 404      | teamNotExist       | %s            | The Knowledge Group does not exist.                               |
| 500      | systemError        | %s            | The service is busy. Try again later.                             |
| 500      | unknownError       | Unknown Error | Unknown error.                                                    |
| 503      | operationTimeout   | %s            | Request timed out.                                                |