# List update requests

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.

Endpoint: GET /sheets/{sheetId}/updaterequests
Version: 2.0.0
Security: APIToken, OAuth2

## Path parameters:

  - `sheetId` (number, required)
    Sheet Id of the sheet being accessed.

## Header parameters:

  - `Authorization` (string)
    API Access Token used to authenticate requests to Smartsheet APIs.
    Example: "Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789"

  - `smartsheet-integration-source` (string)
    Uses the following metadata to distinguish between human-initiated API requests and third-party service-initiated calls by AI Connectors or ITSM:

- Integration source type
- Organization name
- Integration source name 

Format:


TYPE,OrgName,SourceName


Examples: 

AI,SampleOrg,My-AI-Connector-v2

SCRIPT,SampleOrg2,Accounting-updater-script

APPLICATION,SampleOrg3,SheetUpdater
    Example: "AI,SampleOrg,My-AI-Connector-v2"

## Query parameters:

  - `includeAll` (boolean)
    If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).

  - `page` (number)
    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.

  - `pageSize` (number)
    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.

## Response 200 fields (application/json):

  - `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.
    Example: 1

  - `pageSize` (number,null)
    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.
    Example: 50

  - `totalPages` (number)
    The total number of pages in the full result set.
    Example: 25

  - `totalCount` (number)
    The total number of items in the full result set.
    Example: 136

  - `data` (array)
    list of UpdateRequest objects

  - `data.rowIds` (array)
    The Ids of rows to be included.

  - `data.columnIds` (array)
    The Id of the columns to be included.

  - `data.includeAttachments` (boolean)
    Indicates whether to include attachments in the email.

  - `data.includeDiscussions` (boolean)
    Indicates whether to include discussions in the email.

  - `data.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.

  - `data.ccMe` (boolean)
    Indicates whether to send a copy of the email to the sender.

  - `data.message` (string)
    The message of the email.

  - `data.sendTo` (array)
    Array of recipients.

  - `data.subject` (string)
    The subject of the email.

  - `data.id` (number)
    Id of the update request.

  - `data.createdAt` (any)
    The date and time for when this request was originally created.

Read-only.

  - `data.modifiedAt` (any)
    The date and time for when the last change was made to this request.

Read-only.

  - `data.schedule` (object)
    The schedule for which update requests are sent out.

  - `data.schedule.type` (string)
    Type of schedule.
    Enum: "ONCE", "DAILY", "WEEKLY", "MONTHLY", "YEARLY"

  - `data.schedule.dayDescriptors` (array)
    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.
    Enum: "DAY", "WEEKDAY", "WEEKEND", "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"

  - `data.schedule.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.

  - `data.schedule.dayOrdinal` (string)
    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.
    Enum: "FIRST", "LAST", "SECOND", "THIRD", "FOURTH"

  - `data.schedule.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.

  - `data.schedule.endAt` (any)
    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.

  - `data.schedule.lastSentAt` (any)
    The date and time for when the last request was sent.

  - `data.schedule.nextSendAt` (any)
    The date and time for when the next request is scheduled to send.

  - `data.schedule.startAt` (any)
    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.

  - `data.sentBy` (object)
    User object containing name and email of the sender.

  - `data.sentBy.email` (string)
    Example: "jane.doe@smartsheet.com"

  - `data.sentBy.name` (string)
    Example: "Jane Doe"