Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
sheets

List sheets

Gets a list of all sheets that the user has access to. The list contains an abbreviated Sheet object for each sheet.

Note: For pagination guidance, refer to Pagination.

get/sheets

Query parameters

include'sheetVersion' | 'source'

A comma-separated list of optional elements to include in the response:

  • sheetVersion - current version number of each sheet, should not be combined with pagination
  • source - the Source object for any sheet that was created from another sheet, if any
includeAllboolean

If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).

string date-time
OR
number

When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.

numericDatesboolean

You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request.

pagenumber

Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.

pageSizenumber

The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.

Response

SUCCESS.

Note: For pagination guidance, refer to Pagination.

pageNumbernumber

The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned.

pageSizenumber nullable

The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.

totalPagesnumber

The total number of pages in the full result set.

totalCountnumber

The total number of items in the full result set.

Example response

{
  "pageNumber": 1,
  "pageSize": 50,
  "totalPages": 25,
  "totalCount": 136
}