--- title: "List columns" method: GET path: "/sheets/{sheetId}/columns" tags: ["columns"] --- # List columns `GET /sheets/{sheetId}/columns` Gets a list of all columns belonging to the specified sheet. > **Note:** For pagination guidance, refer to [Pagination](/api/smartsheet/guides/basics/pagination). ## Query parameters - `level` integer - `page` number - `pageSize` number - `includeAll` boolean ## Response `200` Returns IndexResult object containing an array of Column 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` Column[] — An array of columns that can be any of the supported types. - union - object — A column of numeric values or text. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: =[Column A]@row + [Column B]@row - `primary` boolean — If set to `true`, the column is the sheet's Primary Column. This property is returned only if the property is set to `true`. - `tags` string[] — This property is only present for *dependency-enabled project sheets.* For details on Gantt view, refer to Create and work with a Gantt view. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of auto-generated numbers. > **Note:** A sheet can have at most one auto number column. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `autoNumberFormat` AutoNumberFormat, required — Specifies how to format values for an auto-generated numbers column. - `fill` string — Indicates zero-padding. It must be between 0 and 10 "0" (zero) characters. - `prefix` string — The prefix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `startingNumber` number — The starting number for the auto-ID. - `suffix` string — The suffix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `systemColumnType` 'AUTO_NUMBER', required — If this property is set, the column contains auto-generated numbers. Its [Auto-number format object](/api/smartsheet/openapi/schemas/autonumberformat) describes the mask used to generate column values. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of checkboxes that you can select or clear. You can display the column checkboxes as one of the following symbols: - box - flag - star - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: "=ISODD([ID]@row)" - `symbol` 'FLAG' | 'STAR' — A checkbox column can use box (default), flag, or star symbols. See [Symbol Columns](/api/smartsheet/openapi/columns). If the box symbol is used, the `symbol` property is absent. - `tags` string[] — If present, `true` cell values indicate completed tasks. This property is only present for dependency-enabled project sheets. For details on Gantt view, refer to Create and work with a Gantt view. For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `type` 'CHECKBOX', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined contacts from which you can choose up to one for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `contactOptions` ContactOption[] — Array of ContactOption objects to specify a pre-defined list of values for the column. - `email` string — A parsable email address. - `name` string — Can be a user's name, display name, or free text. - `formula` string — The formula for the column, if set. For example: =IF(Department@row = "Engineering", "jane.doe@company.com", IF(Department@row = "Marketing", "john.smith@company.com", "admin@company.com")) - `type` 'CONTACT_LIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column that identifies the user who created each row. > **Note:** A sheet has at most, one of these columns. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'CREATED_BY', required — The contact represents the user who created the row. - `type` 'CONTACT_LIST', required - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column of datetime values representing each row's creation datetime. > **Note:** This type of column can only be added via the web application, and a sheet can only have one column of this type. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'CREATED_DATE', required — The system row creation datetime type. - `type` 'DATETIME', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of datetime values. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: =TODAY(-1) - `type` 'DATE', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — Column for datetime values in dependency-enabled project sheets. > **Important:** For the column to represent Gantt or baseline start/end dates, the project sheet must have dependencies enabled. Workload tracking requires connection to the Resource Management product. > > For details on dependency-enabled projects and Gantt view, refer to Activate dependencies and use predecessors in grid and Gantt view. > > For details on baselines, refer to Set baselines on a sheet. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: =TODAY(-1) - `tags` string[] — This property is only present for dependency-enabled project sheets. It indicates what the date represents in terms of the dependency-enabled project. - `type` 'ABSTRACT_DATETIME', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined values from which you can choose for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — A formula that returns a string value that matches one of the symbol options exactly (for example, "Red", "Yellow", "Green"). For example: =[Literal Rating]@row - `options` string[], required — An array of the options available to use in the column. - `type` 'PICKLIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — Cell values in a duration column represent the amount of working time between the current row's start time and its end time. > **Important:** The API doesn't support creating duration columns-you can only create them in the web application. > > Note, duration columns are for *dependency-enabled project sheets only*. > > For details on baselines, refer to Set baselines on a sheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] — This property is only present in dependency-enabled project sheets. It indicates what the duration represents in terms of the dependency-enabled project. - `type` 'DURATION', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column that identifies the user who last modified each row. > **Note:** A sheet has at most, one of these columns. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'MODIFIED_BY', required — If specified, the contact represents the user who created the row or last modified it. - `type` 'CONTACT_LIST', required - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column of datetime values representing each row's last modification datetime. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'MODIFIED_DATE', required — The system row modification datetime type. - `type` 'DATETIME', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined contacts from which you can choose multiple for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `contactOptions` ContactOption[] — Array of ContactOption objects to specify a pre-defined list of values for the column. - `email` string — A parsable email address. - `name` string — Can be a user's name, display name, or free text. - `type` 'MULTI_CONTACT_LIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 1, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined values from which you can choose multiple for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — A formula that returns a string value that matches a combination of the symbol options exactly, and include new line separators between multiple values. For example: =JOIN(Range1@row:Range3@row, CHAR(10)) **Important:** To match multiple symbol option values, the return string must use a new line separator (that is, `CHAR(10)`) between symbol option values. - `options` string[], required — An array of the options available to use in the column. A cell value in this column can contain any number of these options. - `type` 'MULTI_PICKLIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 2, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column tracks each row's progress in terms of percentage complete. - general description > **Important:** This column type is for *dependency-enabled project sheets only*. > > For details on dependency-enabled projects and Gantt view, refer to Activate dependencies and use predecessors in grid and Gantt view. > > For details on baselines, refer to Set baselines on a sheet. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] — This property is only present for dependency-enabled project sheets. For details on Gantt view, refer to Create and work with a Gantt view. For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column specifies zero or more rows on which the current row depends. > **Important:** This column type is for *dependency-enabled project sheets only*. > > For details on dependency-enabled projects and Gantt view, refer to Activate dependencies and use predecessors in grid and Gantt view. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] - `type` 'PREDECESSOR', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column provides a predefined list of contacts from which you can choose a task's assigned resource. > **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `options` string[], required — An array of contacts available to use in the column. A cell value in this column can contain one contact. - `tags` string[] — This property is only present for dependency-enabled project sheets. - `type` 'CONTACT_LIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column represents a resource assigned to each task (row). > **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `primary` boolean — Returned only if the column is the Primary Column (value = **true**). - `tags` string[] — This property is only present for dependency-enabled project sheets. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column specifies how much of a person's (or placeholder's) time can be allotted to a project assignment (task). > **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] — This property is only present for dependency-enabled project sheets. For details on Gantt view, refer to Create and work with a Gantt view. For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined symbols from which you can choose for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — A formula that returns a string value that matches one of the symbol options exactly (for example, "Red", "Yellow", "Green"). For example: =[Literal Rating]@row - `options` string[], required — An array of the options available to use in the column. **Note:** All applicable `options` values are set automatically when you specify the `symbol`. **Important:** You can't specify or update `options` at the same time you're specifying `symbol`. So leave it unspecified when you're creating a column or updating its `symbol`. If needed, you can update `options` in a separate call. - `symbol` 'FLAG' | 'STAR' | 'HARVEY_BALLS' | 'PRIORITY' | 'RYG' | 'PRIORITY_HML' | 'DECISION_SYMBOLS' | 'DECISION_SHAPES' | 'VCR' | 'RYGB' | 'RYGG' | 'WEATHER' | 'PROGRESS' | 'ARROWS_3_WAY' | 'ARROWS_4_WAY' | 'ARROWS_5_WAY' | 'DIRECTIONS_3_WAY' | 'DIRECTIONS_4_WAY' | 'SKI' | 'SIGNAL' | 'STAR_RATING' | 'HEARTS' | 'MONEY' | 'EFFORT' | 'PAIN' — Specifies any type of symbol the column uses. For details and examples, see [Symbol Columns](/api/smartsheet/openapi/columns). - `type` 'PICKLIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). --- [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)