> ## 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. # Get knowledge bases in batches > Call this API to retrieve knowledge bases in batches using parameters such as workspaceIds, option, and withPermissionRole. Use this API to get knowledge bases in batches. When calling the API, send a POST request that includes business fields such as `workspaceIds`, `option`, and `withPermissionRole`. ## Request ### Basic information | Field | Value | | ------------------- | ------------------------------------------------------------------------------------------------------------------ | | HTTP URL | [https://api.dingtalk.io/v2.0/wiki/workspaces/batchQuery](https://api.dingtalk.io/v2.0/wiki/workspaces/batchQuery) | | HTTP Method | POST | | Supported app types | appType-Internal app　appType-Third-party enterprise app | | Required permission | permission-Wiki.Workspace.Read-Knowledge Base read permission | ### Request header | Name | Type | Required | Description | | --------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | x-acs-dingtalk-access-token | String | Yes | The access credential used to call 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 | | ---------- | ------ | -------- | ---------------------------- | | operatorId | String | Yes | The unionId of the operator. | ### Request body | Name | Type | Required | Description | | ------------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | workspaceIds | Array of String | Yes | The Knowledge Base IDs. Call the [Get the Knowledge Base list](/open/development/get-knowledge-base-list#) API and obtain the value of the `workspaceId` field from the response. The maximum size is 20. | | option | Object | No | Optional parameters. | | withPermissionRole | Boolean | No | Whether to return permission information: - **true**: Return - **false**: Do not return Default: false. | ### Request example HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v2.0/wiki/workspaces/batchQuery?operatorId=tXguN309iPhE4roSKPlLURAiEiE HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:access_token Content-Type:application/json { "workspaceIds" : [ "9r09jSO3WARyxd8A" ], "option" : { "withPermissionRole" : false } } ``` 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 { /** * Initialize the account Client with a Token * @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 { java.util.List args = java.util.Arrays.asList(args_); com.aliyun.dingtalkwiki_2_0.Client client = Sample.createClient(); com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesHeaders getWorkspacesHeaders = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesHeaders(); getWorkspacesHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest.GetWorkspacesRequestOption option = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest.GetWorkspacesRequestOption() .setWithPermissionRole(false); com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest getWorkspacesRequest = new com.aliyun.dingtalkwiki_2_0.models.GetWorkspacesRequest() .setOperatorId("tXguN309iPhE4roSKPlLURAiEiE") .setWorkspaceIds(java.util.Arrays.asList( "9r09jSO3WARyxd8A" )) .setOption(option); try { client.getWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, new com.aliyun.teautil.models.RuntimeOptions()); } catch (TeaException err) { if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) { // err contains code and message attributes that help locate 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)) { // err contains code and message attributes that help locate 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 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 a 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() get_workspaces_headers = dingtalkwiki__2__0_models.GetWorkspacesHeaders() get_workspaces_headers.x_acs_dingtalk_access_token = '' option = dingtalkwiki__2__0_models.GetWorkspacesRequestOption( with_permission_role=False ) get_workspaces_request = dingtalkwiki__2__0_models.GetWorkspacesRequest( operator_id='tXguN309iPhE4roSKPlLURAiEiE', workspace_ids=[ '9r09jSO3WARyxd8A' ], option=option ) try: client.get_workspaces_with_options(get_workspaces_request, get_workspaces_headers, util_models.RuntimeOptions()) except Exception as err: if not UtilClient.empty(err.code) and not UtilClient.empty(err.message): # err contains code and message attributes that help locate the issue pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() get_workspaces_headers = dingtalkwiki__2__0_models.GetWorkspacesHeaders() get_workspaces_headers.x_acs_dingtalk_access_token = '' option = dingtalkwiki__2__0_models.GetWorkspacesRequestOption( with_permission_role=False ) get_workspaces_request = dingtalkwiki__2__0_models.GetWorkspacesRequest( operator_id='tXguN309iPhE4roSKPlLURAiEiE', workspace_ids=[ '9r09jSO3WARyxd8A' ], option=option ) try: await client.get_workspaces_with_options_async(get_workspaces_request, get_workspaces_headers, util_models.RuntimeOptions()) except Exception as err: if not UtilClient.empty(err.code) and not UtilClient.empty(err.message): # err contains code and message attributes that help locate the issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $getWorkspacesHeaders = new GetWorkspacesHeaders([]); $getWorkspacesHeaders->xAcsDingtalkAccessToken = ""; $option = new option([ "withPermissionRole" => false ]); $getWorkspacesRequest = new GetWorkspacesRequest([ "operatorId" => "tXguN309iPhE4roSKPlLURAiEiE", "workspaceIds" => [ "9r09jSO3WARyxd8A" ], "option" => $option ]); try { $client->getWorkspacesWithOptions($getWorkspacesRequest, $getWorkspacesHeaders, 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)) { // err contains code and message attributes that help locate 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 ( "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" ) /** * Initialize the account Client with a 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 } getWorkspacesHeaders := &dingtalkwiki_2_0.GetWorkspacesHeaders{} getWorkspacesHeaders.XAcsDingtalkAccessToken = tea.String("") option := &dingtalkwiki_2_0.GetWorkspacesRequestOption{ WithPermissionRole: tea.Bool(false), } getWorkspacesRequest := &dingtalkwiki_2_0.GetWorkspacesRequest{ OperatorId: tea.String("tXguN309iPhE4roSKPlLURAiEiE"), WorkspaceIds: []*string{tea.String("9r09jSO3WARyxd8A")}, Option: option, } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.GetWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, &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)) { // err contains code and message attributes that help locate the issue } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} // This file is auto-generated, don't edit it import Util, * as $Util from '@alicloud/tea-util'; import dingtalkwiki_2_0, * as $dingtalkwiki_2_0 from '@alicloud/dingtalk/wiki_2_0'; import OpenApi, * as $OpenApi from '@alicloud/openapi-client'; import * as $tea from '@alicloud/tea-typescript'; export default class Client { /** * Initialize the account Client with a Token * @return Client * @throws Exception */ static createClient(): dingtalkwiki_2_0 { let config = new $OpenApi.Config({ }); config.protocol = "https"; config.regionId = "central"; return new dingtalkwiki_2_0(config); } static async main(args: string[]): Promise { let client = Client.createClient(); let getWorkspacesHeaders = new $dingtalkwiki_2_0.GetWorkspacesHeaders({ }); getWorkspacesHeaders.xAcsDingtalkAccessToken = ""; let option = new $dingtalkwiki_2_0.GetWorkspacesRequestOption({ withPermissionRole: false, }); let getWorkspacesRequest = new $dingtalkwiki_2_0.GetWorkspacesRequest({ operatorId: "tXguN309iPhE4roSKPlLURAiEiE", workspaceIds: [ "9r09jSO3WARyxd8A" ], option: option, }); try { await client.getWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, new $Util.RuntimeOptions({ })); } catch (err) { if (!Util.empty(err.code) && !Util.empty(err.message)) { // err contains code and message attributes that help locate the issue } } } } 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 { /** * Initialize the account Client with a Token * @return Client * @throws 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.GetWorkspacesHeaders getWorkspacesHeaders = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesHeaders(); getWorkspacesHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest.GetWorkspacesRequestOption option = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest.GetWorkspacesRequestOption { WithPermissionRole = false, }; AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest getWorkspacesRequest = new AlibabaCloud.SDK.Dingtalkwiki_2_0.Models.GetWorkspacesRequest { OperatorId = "tXguN309iPhE4roSKPlLURAiEiE", WorkspaceIds = new List { "9r09jSO3WARyxd8A" }, Option = option, }; try { client.GetWorkspacesWithOptions(getWorkspacesRequest, getWorkspacesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions()); } catch (TeaException err) { if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains code and message attributes that help locate the issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err contains code and message attributes that help locate the issue } } } } } ``` ## Response ### Response body | Name | Type | Description | | -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | workspaces | Array | The list of knowledge bases. | | workspaceId | String | The Knowledge Base ID (spaceUuid). | | corpId | String | The organization ID that the Knowledge Base belongs to. | | teamId | String | The ID of the Knowledge Group that the Knowledge Base belongs to. Returns empty if the Knowledge Base does not belong to any Knowledge Group. | | rootNodeId | String | The root node ID (root node dentryUuid). | | name | String | The Knowledge Base name. | | type | String | The Knowledge Base type. Enum values: - **TEAM**: Knowledge Base - **PERSONAL**: My Docs | | description | String | The Knowledge Base description. | | url | String | The URL used to access the Knowledge Base. | | icon | Object | The Knowledge Base icon. | | 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 URL of the Knowledge Base cover. | | creatorId | String | The userId of the Knowledge Base creator. | | modifierId | String | The userId of the user who last modified the Knowledge Base. | | createTime | String | The time when the Knowledge Base was created. | | modifiedTime | String | The time when the Knowledge Base was last modified. | | permissionRole | String | The permission role of the requester on the Knowledge Base. Enum values: - **OWNER**: Owner - **MANAGER**: Manager - **EDITOR**: Editor - **DOWNLOADER**: Viewer who can download - **READER**: View-only - **NONE**: No permission | ### 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", "teamId" : "lHiicjNFM2iSFYSdz2iPuI8ZwiEiE", "rootNodeId" : "ZgpG2NdyVXXjrKKzIBqMp5zkVMwvDqPk", "name" : "workspace_name", "type" : "TEAM", "description" : "workspace_description", "url" : "workspace_url", "icon" : { "type" : "URL", "value" : "https://example/file-manage-files/zh-CN/202***13/ldet/avatar3.jpg" }, "cover" : "https://example/file-manage-files/zh-CN/202***13/ldet/XXXX.jpg", "creatorId" : "01472825524039877041", "modifierId" : "01472825524039877041", "createTime" : "2023-05-15T11:29Z", "modifiedTime" : "2023-05-15T11:29Z", "permissionRole" : "READER" } ] } ``` ### Error codes If an error is returned when you call this API, look up the error message in the [Global error codes](/open/development/server-api-error-codes-1) document to find a solution. | HttpCode | Error code | Error message | Description | | -------- | ----------------- | ------------- | ----------------------------------------------------------------- | | 400 | paramError | %s | Parameter error. | | 403 | permissionDenied | %s | The current user does not have permission to perform this action. | | 404 | workspaceNotExist | %s | The Knowledge Base does not exist. | | 500 | systemError | %s | The service is busy. Try again later. | | 500 | unknownError | Unknown Error | Unknown error. | | 503 | operationTimeout | %s | The request timed out. |