SMsmartsheet
home

List folders in home

Lists the folders in your Sheets folder. The list contains an abbreviated Folder object for each folder.

Note: For pagination guidance, refer to Pagination.

DEPRECATED - The Sheets folder is being replaced by workspaces. To adapt to this change, please see Migrate from using the Sheets folder.

get/home/folders

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

Query parameters

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).

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

IndexResult object containing an array of Folder objects.

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
}

Changes

No recorded changes to this operation across all 16 revisions of this API.