Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tableau Desktop Workbooks API

Manage and download workbooks.

Tableau Desktop Workbooks API is one of 12 APIs that Tableau Desktop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workbooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 3.22.

Requests are made against a single base URL, https://{tableau-server}/api/3.22.

6 operations 3 paths 2 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.22
Base URL
https://tableau-server/api/3.22
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Tableau Desktop Workbooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Tableau-Auth (tableauAuth). By default, every request must be authenticated.

  • tableauAuth — Authentication token returned by the Sign In endpoint.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workbooks 6

Manage and download workbooks.

GET
/sites/{siteId}/workbooks
Query Workbooks for Site
queryWorkbooksForSite 1 param → 200
POST
/sites/{siteId}/workbooks
Publish Workbook
publishWorkbook 1 param body → 201
GET
/sites/{siteId}/workbooks/{workbookId}
Query Workbook
queryWorkbook 2 params → 200
PUT
/sites/{siteId}/workbooks/{workbookId}
Update Workbook
updateWorkbook 2 params body → 200
DELETE
/sites/{siteId}/workbooks/{workbookId}
Delete Workbook
deleteWorkbook 2 params → 204
GET
/sites/{siteId}/workbooks/{workbookId}/content
Download Workbook
downloadWorkbook 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

Request
object
Generic Tableau REST API request envelope (tsRequest).
Response
object
Generic Tableau REST API response envelope (tsResponse).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-desktop-workbooks-api-openapi.yml Raw ↑

Other APIs Tableau Desktop publishes across the network.

Tableau Extensions API
Tableau Hyper API
Tableau Embedding API
Tableau Metadata API
Tableau Server Client (Python)
Tableau Desktop Authentication API
Tableau Desktop Data Sources API
Tableau Desktop Projects API
Tableau Desktop Server API
Tableau Desktop Sites API
Tableau Desktop Users API