--- title: "List update requests" method: GET path: "/sheets/{sheetId}/updaterequests" tags: ["updateRequests"] --- # List update requests `GET /sheets/{sheetId}/updaterequests` Gets a summarized list of all update requests that have future schedules associated with the specified sheet. Only the following fields are returned in the response: * **id** * **ccMe** * **createdAt** * **message** * **modifiedAt** * **schedule** * **sendTo** * **sentBy** * **subject** > **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination). ## Query parameters - `includeAll` boolean - `page` number - `pageSize` number ## Response `200` The list of UpdateRequest 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` UpdateRequest[] — list of UpdateRequest objects - `ccMe` boolean — Indicates whether to send a copy of the email to the sender. - `message` string — The message of the email. - `sendTo` Recipient[] — Array of recipients. - union — Specifies the recipient of an email. The recipient may be either an individual or a group. To specify an individual, set the email attribute; to specify a group, set the groupId attribute. Either email and groupId may be set, but not both. - RecipientIndividual — Specifies the recipient of an [Email](/api/smartsheet/openapi/schemas/email). The recipient may be either an individual or a group. To specify an individual, set the `email` attribute; to specify a group, set the `groupId` attribute. Either `email` and `groupId` may be set, but not both. - `email` string, email — The email address of an individual recipient. - RecipientGroup — Specifies the recipient of an [Email](/api/smartsheet/openapi/schemas/email). The recipient may be either an individual or a group. To specify an individual, set the `email` attribute; to specify a group, set the `groupId` attribute. Either **email** and `groupId` may be set, but not both. - `groupId` number — The ID of a group recipient. - `subject` string — The subject of the email. - `columnIds` number[] — The ID of the columns to be included. - `includeAttachments` boolean — Indicates whether to include attachments in the email. - `includeDiscussions` boolean — Indicates whether to include discussions in the email. - `layout` boolean — One of the following values: **HORIZONTAL** or **VERTICAL**. Optional, defaults to **HORIZONTAL** when multiple rows are being sent and to **VERTICAL** when a single row is being sent. **HORIZONTAL** formats the rows being sent as a grid, whereas **VERTICAL** formats the rows being sent as separate cards. - `rowIds` number[] — The Ids of rows to be included. - `id` number — ID of the update request. - `createdAt` union - string, date-time - number - `modifiedAt` union - string, date-time - number - `schedule` Schedule - `type` 'ONCE' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY' — Type of schedule. - `dayDescriptors` string[] — A string array consists of one or more of the following values: * **DAY**, **WEEKDAY**, **WEEKEND** * **SUNDAY**, **MONDAY**, **TUESDAY**, **WEDNESDAY**, **THURSDAY**, **FRIDAY**, **SATURDAY** The subset of values applicable to the schedule type are as followed: | Value | Daily schedule | Weekly schedule | Monthly schedule | |---------------|----------------|-----------------|------------------| | **DAY** | | | **✓** | | **WEEKDAY** | **✓** | | **✓** | | **WEEKEND** | | | **✓** | | **SUNDAY** | | **✓** | **✓** | | **MONDAY** | | **✓** | **✓** | | **TUESDAY** | | **✓** | **✓** | | **WEDNESDAY** | | **✓** | **✓** | | **THURSDAY** | | **✓** | **✓** | | **FRIDAY** | | **✓** | **✓** | | **SATURDAY** | | **✓** | **✓** | For more details, refer to the Table of Schedule Object’s Attributes below. - `dayOfMonth` number — The day within the month. Valid range is 1 to 28. This attribute is applicable to the following schedule type: * **MONTHLY** For more details, refer to the Table of Schedule Object’s Attributes below. - `dayOrdinal` 'FIRST' | 'LAST' | 'SECOND' | 'THIRD' | 'FOURTH' — Must be one of the following values: * **FIRST** or **LAST** * **SECOND**, **THIRD**, or **FOURTH** This attribute is applicable to the following schedule type: * **MONTHLY** For more details, refer to the Table of Schedule Object’s Attributes below. - `repeatEvery` number — Frequency on which the request is delivered. The unit is a function of the **type** attribute. For example, for **MONTHLY** schedule, **repeatEvery=1** means every month. Valid range is 1 to 99. This attribute is applicable to the following schedule types: **DAILY**, **WEEKLY**, **MONTHLY**, or **YEARLY**. For more details, refer to the Table of Schedule Object’s Attributes below. - `endAt` union - string, date-time — The date, time, and time zone at which the delivery schedule ends. The value is either in a string format or a numeric format: * When the value is a string, it must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD). * When the value is a number, it represents a date and time with no offset (UTC time zone). See Dates and Times for more information. The value must be later than startAt and the current date and time. The value must contain zero hours, zero minutes, and zero seconds. The offset (time zone) value must be the same as the offset (time zone) value in startAt. This attribute is applicable to the following schedule types: DAILY, WEEKLY, MONTHLY, YEARLY. For more details, refer to the Table of Schedule Object’s Attributes below. - number — The date, time, and time zone at which the delivery schedule ends. The value is either in a string format or a numeric format: * When the value is a string, it must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD). * When the value is a number, it represents a date and time with no offset (UTC time zone). See Dates and Times for more information. The value must be later than startAt and the current date and time. The value must contain zero hours, zero minutes, and zero seconds. The offset (time zone) value must be the same as the offset (time zone) value in startAt. This attribute is applicable to the following schedule types: DAILY, WEEKLY, MONTHLY, YEARLY. For more details, refer to the Table of Schedule Object’s Attributes below. - `lastSentAt` union - string, date-time — The date and time for when the last request was sent. - number — The date and time for when the last request was sent. - `nextSendAt` union - string, date-time — The date and time for when the next request is scheduled to send. - number — The date and time for when the next request is scheduled to send. - `startAt` union - string, date-time — The date, time, and time zone at which the first delivery starts. The value is either in a string format or a numeric format: * When the value is a string, it must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD). * When the value is a number, it represents a date and time with no offset (UTC time zone). See [Dates and times](/api/smartsheet/guides/basics/dates-and-times) for more information. For ONCE schedule type, it must be later than the current date time. For all other schedule types, it must be later than “2000-01-01T00:00:00Z” in string format or 946684800000 in numeric format. The value must contain zero minutes and zero seconds. This attribute is applicable to all schedule types. For more details, refer to the Table of Schedule Object’s Attributes below. - number — The date, time, and time zone at which the first delivery starts. The value is either in a string format or a numeric format: * When the value is a string, it must be a valid ISO-8601 date and time with an offset (YYYY-MM-DDThh:mm:ssTZD). * When the value is a number, it represents a date and time with no offset (UTC time zone). See [Dates and times](/api/smartsheet/guides/basics/dates-and-times) for more information. For ONCE schedule type, it must be later than the current date time. For all other schedule types, it must be later than “2000-01-01T00:00:00Z” in string format or 946684800000 in numeric format. The value must contain zero minutes and zero seconds. This attribute is applicable to all schedule types. For more details, refer to the Table of Schedule Object’s Attributes below. - `sentBy` MiniUser — MiniUser Object - `email` string, email - `name` string --- [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)