--- schema_version: "1" id: 20a7168f3ef4345f096213f49a9ea1220831d2ba46a10fa71e8474ee124e8073 title: WorkbooksConnection collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/metadata_api/reference/workbooksconnection.doc.md canonical_url: https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbooksconnection.doc.html source_site: help.tableau.com content_type: documentation content_hash: 82cca45fa63629b3b07781fe92261a95ea91b0d331cda000ddb84873f79946d9 --- _menu_ Types OBJECT # WorkbooksConnection Connection Type for Workbook ## [_link_](#graphql-schema-definition) GraphQL Schema definition ` - type WorkbooksConnection { - # List of nodes - nodes: [[Workbook](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/workbook.doc.html)!]! - # Information for pagination - pageInfo: [PageInfo](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/pageinfo.doc.html)! - # Total number of objects in connection - totalCount: [Int](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/int.doc.html)! - } ` ## [_link_](#require-by) Require by - [BinField_GraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_bins.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/binfield.doc.html "BinField - GraphQL type for a binned continuous measure field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_bins.html") - [CalculatedField_GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations\_calculatedfields.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/calculatedfield.doc.html "CalculatedField - GraphQL type for a calculated field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/calculations_calculatedfields.html") - [CloudFile_A cloud file connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/cloudfile.doc.html "CloudFile - A cloud file connection") - [Column_GraphQL type for a table column_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/column.doc.html "Column - GraphQL type for a table column") - [ColumnField_ColumnFields are a type of field which directly connects to a column in some type of table._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/columnfield.doc.html "ColumnField - ColumnFields are a type of field which directly connects to a column in some type of table.") - [CombinedField_GraphQL type for a combined field. Combined fields concatanate fields together into one string._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/combinedfield.doc.html "CombinedField - GraphQL type for a combined field. Combined fields concatanate fields together into one string.") - [CombinedSetField_GraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html#Combine_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/combinedsetfield.doc.html "CombinedSetField - GraphQL type for a combined set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html#Combine") - [CustomSQLTable_A table that represents the result of evaluating a custom SQL query. These "tables" are owned by the Tableau data source (embedded or published) which contains the SQL query, so they only exist within that data source._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/customsqltable.doc.html "CustomSQLTable - A table that represents the result of evaluating a custom SQL query. These \"tables\" are owned by the Tableau data source (embedded or published) which contains the SQL query, so they only exist within that data source.") - [Database_A database containing tables_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/database.doc.html "Database - A database containing tables") - [DatabaseServer_A database server connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databaseserver.doc.html "DatabaseServer - A database server connection") - [DatabaseTable_A table that is contained in a database_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/databasetable.doc.html "DatabaseTable - A table that is contained in a database") - [DataCloud_A Data Cloud connection \*Available in Tableau Cloud February 2024 / Server 2024.2 and later.\*_](datacloud.doc.html "DataCloud - A Data Cloud connection *Available in Tableau Cloud February 2024 / Server 2024.2 and later.*") - [Datasource_Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm_](datasource.doc.html "Datasource - Root GraphQL type for embedded and published data sources Data sources are a way to represent how Tableau Desktop and Tableau Server model and connect to data. Data sources can be published separately, as a published data source, or may be contained in a workbook as an embedded data source. See https://onlinehelp.tableau.com/current/server/en-us/datasource.htm") - [DatasourceField_GraphQL type for a data source field. Data source fields can only exist in embedded data sources which connect to a published data source. A data source field is an embedded data source's 'layered' representation of a field that already exists in the published data source and is mostly a copy of the field in the published data source. Data source fields can get their own descriptions and renames local to the embedded data source, but cannot otherwise be modified in the embedded data source._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/datasourcefield.doc.html "DatasourceField - GraphQL type for a data source field. Data source fields can only exist in embedded data sources which connect to a published data source. A data source field is an embedded data source's 'layered' representation of a field that already exists in the published data source and is mostly a copy of the field in the published data source. Data source fields can get their own descriptions and renames local to the embedded data source, but cannot otherwise be modified in the embedded data source.") - [EmbeddedDatasource_A data source embedded in a workbook_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/embeddeddatasource.doc.html "EmbeddedDatasource - A data source embedded in a workbook") - [Field_Base GraphQL type for a field_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/field.doc.html "Field - Base GraphQL type for a field") - [File_A file connection_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/file.doc.html "File - A file connection") - [Flow_Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flow.doc.html "Flow - Flows are used to prepare data, which can include aggregation, cleaning, preprocessing, etc.") - [FlowColumnOutputField_Column output field implementation_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowcolumnoutputfield.doc.html "FlowColumnOutputField - Column output field implementation") - [FlowFieldOutputField_Field output field implementation_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowfieldoutputfield.doc.html "FlowFieldOutputField - Field output field implementation") - [FlowOutputField_A wrapper for an output field contained in a published flow._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/flowoutputfield.doc.html "FlowOutputField - A wrapper for an output field contained in a published flow.") - [GroupField_GraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_groups\_creating.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/groupfield.doc.html "GroupField - GraphQL type for a group field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_groups_creating.html") - [HierarchyField_GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs\_hierarchies.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/hierarchyfield.doc.html "HierarchyField - GraphQL type for a hierarchy. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/qs_hierarchies.html") - [Lens_Lenses are curated, embeddable Ask Data experiences. \*Introduced in Tableau Cloud June 2022 / Server 2022.3.\* \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](lens.doc.html "Lens - Lenses are curated, embeddable Ask Data experiences. *Introduced in Tableau Cloud June 2022 / Server 2022.3.* *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [Metric_Metrics are time series data constructed from fields contained in views. \*Retired in Tableau Cloud February 2024 / Server 2024.2.\*_](metric.doc.html "Metric - Metrics are time series data constructed from fields contained in views. *Retired in Tableau Cloud February 2024 / Server 2024.2.*") - [PublishedDatasource_A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks._](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/publisheddatasource.doc.html "PublishedDatasource - A Tableau data source that has been published separately to Tableau Server. It can be used by multiple workbooks.") - [Query_Query root for Metadata GraphQL interface_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/query.doc.html "Query - Query root for Metadata GraphQL interface") - [SetField_GraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup\_sets\_create.html_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/setfield.doc.html "SetField - GraphQL type for a set field. See https://onlinehelp.tableau.com/current/pro/desktop/en-us/sortgroup_sets_create.html") - [Table_A table containing columns_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/table.doc.html "Table - A table containing columns") - [TableauSite_Site on Tableau server_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableausite.doc.html "TableauSite - Site on Tableau server") - [TableauUser_User on a site on Tableau server_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tableauuser.doc.html "TableauUser - User on a site on Tableau server") - [Tag_A tag associated with content items_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/tag.doc.html "Tag - A tag associated with content items") - [VirtualConnection_A virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnection.doc.html "VirtualConnection - A virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [VirtualConnectionTable_A table in a virtual connection. \*Available in Tableau Cloud March 2022 / Server 2022.1 and later.\*_](virtualconnectiontable.doc.html "VirtualConnectionTable - A table in a virtual connection. *Available in Tableau Cloud March 2022 / Server 2022.1 and later.*") - [WebDataConnector_A web data connector_](https://help.tableau.com/v0.0/api/metadata_api/en-us/reference/webdataconnector.doc.html "WebDataConnector - A web data connector")