Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1415122102.4 KB

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

post/workbooks/{workbookId}/tables/{tableId}/rows/list

Path parameters

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

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Request body

rowIdsRowId[]

This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.

maxResultsinteger

The maximum number of rows 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

columnIdsResourceId[] required

The list of columns in the table whose row data is returned in the result.

rowIdsNotFoundRowId[]

The list of row ids included in the request that were not found in the table.

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 required

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.