Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1415122102.4 KB

The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

post/screendata

Request body

workbookIdstring required

The ID of the workbook that contains the screen.

appIdstring required

The ID of the app that contains the screen.

screenIdstring required

The ID of the screen.

variablesobject

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

maxResultsinteger
<p> The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100. </p> <p> This parameter is optional. If you don't specify this parameter, the default page size is 100. </p>
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

resultsobject required

A map of all the rows on the screen keyed by block name.

workbookCursorinteger required

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

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 query has been loaded.