---
title: "List folders in home"
method: GET
path: "/home/folders"
tags: ["home"]
deprecated: true
---

# List folders in home

`GET /home/folders`

> **Deprecated.**

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

> **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).

**DEPRECATED** - The Sheets folder is being replaced by workspaces. To adapt to this change, please see [Migrate from using the Sheets folder](/api/smartsheet/guides/updating-code/migrate-from-using-the-sheets-folder).

## Query parameters

- `includeAll` boolean
- `page` number
- `pageSize` number

## Response `200`

IndexResult object containing an array of Folder objects.

**Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination).

- object
  - `pageNumber` number — 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.
  - `pageSize` number, 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.
  - `totalPages` number — The total number of pages in the full result set.
  - `totalCount` number — The total number of items in the full result set.
  - `result` Folder[]
    - `id` number — Folder ID.
    - `favorite` boolean — **Deprecated** Returned only if the user has marked the folder as a favorite in their "Home" tab (value = true).
    - `folders` Folder[] — Folders contained in folder.
    - `name` string — Folder name.
    - `permalink` string — URL that represents a direct link to the folder in Smartsheet.
    - `reports` GridListing[] — Reports contained in folder.
      - `id` number — Asset ID.
      - `name` string — Asset name.
      - `permalink` string — URL that represents a direct link to the asset in Smartsheet.
    - `sheets` GridListing[] — Sheets contained in folder.
      - `id` number — Asset ID.
      - `name` string — Asset name.
      - `permalink` string — URL that represents a direct link to the asset in Smartsheet.
    - `sights` DashboardListing[] — Dashboards contained in folder.
      - `id` number — Asset ID.
      - `name` string — Asset name.
      - `permalink` string — URL that represents a direct link to the asset in Smartsheet.
      - `createdAt` union
        - string, date-time
        - number
      - `modifiedAt` union
        - string, date-time
        - number
    - `templates` GridListing[] — Templates contained in folder.
      - `id` number — Asset ID.
      - `name` string — Asset name.
      - `permalink` string — URL that represents a direct link to the asset in Smartsheet.

## Other responses

- `default` — Generic Error Payload

---

[API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)