---
title: "Get favorites"
method: GET
path: "/favorites"
tags: ["favorites"]
---

# Get favorites

`GET /favorites`

Gets a list of all of the user's favorite items.

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

## Query parameters

- `includeAll` boolean
- `page` number
- `pageSize` number
- `include` 'directId' | 'name'

## Response `200`

IndexResult object containing an array of Favorite 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.
  - `data` Favorite[]
    - `objectId` number — The ID of the favorited item. If type is template, only private sheet-type template ID is allowed.
    - `type` 'folder' | 'report' | 'sheet' | 'sight' | 'template' | 'workspace'

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