Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
rows

Sort rows in sheet

Sorts the rows of a sheet, either in ascending or descending order.

post/sheets/{sheetId}/sort

Query parameters

include&excludestring

(Optional) Any of the relevant parameters or query parameters listed for Get Sheet.

Request body

Response

Returns Sheet object, populated according to the specified parameters.

idnumber

Sheet ID.

fromIdnumber

The ID of the template from which to create the sheet. This attribute can be specified in a request, but is never present in a response.

ownerIdnumber

User ID of the sheet owner.

accessLevel'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER'
cellImageUploadEnabledboolean

The sheet is enabled for cell images to be uploaded.

dependenciesEnabledboolean

Indicates whether dependencies are enabled.

effectiveAttachmentOptionsstring[]

Array of enum strings (see Attachment.attachmentType indicating the allowable attachment options for the current user and sheet.

favoriteboolean

Deprecated Returned only if the user has marked this sheet as a favorite in their Home tab (value = true).

ganttEnabledboolean

Indicates whether "Gantt View" is enabled.

hasSummaryFieldsboolean

Indicates whether a sheet summary is present.

isMultiPicklistEnabledboolean

Indicates whether multi-select is enabled.

namestring

Sheet name.

ownerstring

Email address of the sheet owner.

permalinkstring

URL that represents a direct link to the sheet in Smartsheet.

readOnlyboolean

Returned only if the sheet belongs to an expired trial (value = true).

resourceManagementEnabledboolean

Indicates that resource management is enabled.

resourceManagementType'NONE' | 'LEGACY_RESOURCE_MANAGEMENT' | 'RESOURCE_MANAGEMENT_BY_SMARTSHEET'

Resource Management type. Indicates the type of RM that is enabled.

showParentRowsForFiltersboolean

Returned only if there are column filters on the sheet. Value = true if "show parent rows" is enabled for the filters.

totalRowCountnumber

The total number of rows in the sheet.

versionnumber

A number that is incremented every time a sheet is modified.