Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1415122102.4 KB

The ListTables API allows you to retrieve a list of all the tables in a workbook.

get/workbooks/{workbookId}/tables

Path parameters

workbookIdstring required
<p>The ID of the workbook whose tables are being retrieved.</p> <p> If a workbook with the specified id could not be found, this API throws ResourceNotFoundException. </p>

Query parameters

maxResultsinteger

The maximum number of tables to return in each page of the results.

nextTokenstring
<p> This parameter is optional. If a nextToken is not specified, the API returns the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException. </p>

Response

Success

nextTokenstring

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the request has been loaded.

workbookCursorinteger

Indicates the cursor of the workbook at which the data returned by this request is read. Workbook cursor keeps increasing with every update and the increments are not sequential.