SMsmartsheet
reports

List reports

List all Reports accessible to the user.

Note: For pagination guidance, refer to Pagination.

get/reports

Request

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

Query parameters

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.

Response

Object containing an array of all accessible reports, referenced by their ID, name, access level, and summary report flag values.

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,
  "data": [
    {
      "id": 987654321,
      "name": "Q2 Earnings",
      "permalink": "https://app.smartsheet.com/reports/c8gJxw87cXpRCvCC5PPw6jFhFRrf5r8PxCrxvW21"
    }
  ]
}

Changes

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