Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
proofs

List proof discussions

Gets a list of all discussions that are in the proof.

Note: For pagination guidance, refer to Pagination.

get/sheets/{sheetId}/proofs/{proofId}/discussions

Query parameters

include'attachments' | 'comments'

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

  • attachments - effective only if comments is present, otherwise ignored
  • comments - include all comments in threads
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.

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

Response

OK.

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": [
    {
      "comments": [
        {
          "attachments": [
            {
              "mimeType": "PNG",
              "createdBy": {
                "email": "jane.doe@smartsheet.com",
                "name": "Jane Doe"
              }
            }
          ],
          "createdBy": {
            "email": "jane.doe@smartsheet.com",
            "name": "Jane Doe"
          }
        }
      ],
      "commentAttachments": [
        {
          "mimeType": "PNG",
          "createdBy": {
            "email": "jane.doe@smartsheet.com",
            "name": "Jane Doe"
          }
        }
      ],
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "lastCommentedUser": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      }
    }
  ]
}