Skip to content
Last updated

Query parameters

You can modify behavior of some operations by using the following query parameters.

Query ParameterTypeDescriptionMore Info
accessApiLevelnumberAllows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1.
allowPartialSuccessbooleanIf set to true, allows bulk operations to process even if one or more operations are invalid for some reason, for example, allowPartialSuccess=true.Bulk Operations
include or excludestringWhen applicable for a specific object, various include or exclude parameters are available, for example, include=format.Object reference or cell formatting
includeAllbooleanIf set to true, the operation returns all the items in a single response.

Note: The includeAll parameter is deprecated for several operations. See the operation documentation or the Changelog for details.
Offset-based pagination
lastKeystringIf your previous call to the endpoint indicated more items remained (that is, the response included a lastKey property with a token value), set the lastKey parameter to that token to retrieve the next page of items. If you omit lastKey, the endpoint returns the first page of results.Token-based pagination
levelnumberUse for complex objects.Working with Complex Objects
numericDatesbooleanIf set to true, allows you to input or receive dates in numeric format, for example, numericDates=true.Dates and Times
maxItemsintegerThe maximum number of items to return per page.

The maxItems parameter is available for operations that use token-based pagination.
Token-based pagination
pagestringSpecifies which page of items to return in the response.

Note: The page parameter is deprecated for several operations. See the operation documentation or the Changelog for details.
Offset-based pagination
pageSizenumberThe maximum number of items to return per page.

Note: The pageSize parameter is deprecated for several operations. See the operation documentation or the Changelog for details.
Offset-based pagination

Note: Query strings are case sensitive. If you do not see the expected response, confirm that your query is formatted correctly.