Skip to main content

List Workbooks

Retrieves a list of workbooks.

This tool returns a single page of up to 1000 workbooks per call. The response is a flat object of the shape { data, totalAvailable } (see Example result). To collect every workbook, start at pageNumber: 1 and increment pageNumber on each subsequent call until you have collected totalAvailable items.

To get the count of workbooks matching the request, read totalAvailable from a single call (for example, pageNumber: 1) without paging through every item.

APIs called​

Optional arguments​

filter​

A filter expression as defined in the Tableau REST API Workbooks filter fields.

Example: name:eq:Superstore

limit​

The maximum number of workbooks to return from the requested page. Must be a positive integer no greater than 1000 (the fixed page size). Use this to fetch fewer than a full page — for example, to request a partial final page. It does not fetch across pages.

Example: 500

See also: MAX_RESULT_LIMIT, the overall cap on how many results can be paginated through across all pages.

pageNumber​

Which 1000-item page of workbooks to fetch. This is a 1-based page index (page size is fixed at 1000); when omitted it defaults to 1. Increment pageNumber across calls to page through the full result set.

When a server-side MAX_RESULT_LIMIT is configured, only pages that fall within that cap are reachable. For example, with a limit of 2700 the highest page you can request is 3 (page 3 returns the final 700 items). Requesting a higher page returns an error describing the valid page range rather than an empty result.

Example: 2

Example result​

{
  "data": [
    {
      "id": "222ea993-9391-4910-a167-56b3d19b4e3b",
      "name": "Superstore",
      "webpageUrl": "https://10ax.online.tableau.com/#/site/mcp-test/workbooks/1412200",
      "contentUrl": "Superstore",
      "project": {
        "name": "Samples",
        "id": "cbec32db-a4a2-4308-b5f0-4fc67322f359"
      },
      "showTabs": true,
      "defaultViewId": "9460abfe-a6b2-49d1-b998-39e1ebcc55ce",
      "tags": {}
    }
  ],
  "totalAvailable": 1
}

The response fields are:

  • data: the workbooks on the requested page (at most 1000, or fewer when limit or a server cap applies).
  • totalAvailable: the number of workbooks available for pagination (Your own limit argument does not affect this value).