CData Python Connector for Smartsheet

Build 25.0.9454

Info_Columns

Read and write properties of columns in your Smartsheet sheets.

Table-specific Information

SELECT

This table returns details for columns in a specified sheet. The SheetId column is always required in the criteria.

Retrieve all columns in a sheet.

SELECT * FROM Info_Columns WHERE SheetId = '568679927703428'

Retrieve details of a specific column in the sheet.

SELECT * FROM Info_Columns WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

INSERT

You can create a new column in the sheet by providing the SheetId, Index, Title, and Type properties as shown in the example query below.
INSERT INTO Info_Columns (SheetId, Index, Title, Type) VALUES ('568679927703428', 1, 'Test Column 1', 'TEXT_NUMBER')

UPDATE

You can update the properties of a column in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.
UPDATE Info_Columns SET Index = 3, Title = 'Transportation', Type = 'PICKLIST', OptionsAggregate = '["ship", "motorcycle", "airplane"]', Hidden = false, Width = 30, Locked = false, LockedForUser = false WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

DELETE

You can delete one of the columns in the sheet by specifying the SheetId and Id columns in the criteria as shown in the example query below.
DELETE FROM Info_Columns WHERE SheetId = '568679927703428' AND Id = '1967782344478596'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the column, used to reference it programmatically.

Index Integer False

The numeric position of the column in the sheet, starting at 0 for the first column.

Title String False

The displayed name of the column, as shown in the Smartsheet interface.

Primary Boolean True

Indicates whether this column is the primary column, which typically contains key identifiers or names for rows.

Type String False

The functional data type of the column, determining how data is stored and validated.

The allowed values are TEXT_NUMBER, CHECKBOX, DATE, DATETIME, ABSTRACT_DATETIME, PICKLIST, MULTI_PICKLIST, CONTACT_LIST, MULTI_CONTACT_LIST, DURATION, PREDECESSOR.

OptionsAggregate String False

A list of selectable options for the column, applicable for columns like dropdowns or picklists.

ContactOptions String False

Array of the contact options available for the column.

Hidden Boolean False

Indicates whether the column is hidden in the Smartsheet interface.

Symbol String False

Represents visual markers or indicators used in the column, with values varying by column type (for example, checkboxes, picklists).

The allowed values are ARROWS_3_WAY, ARROWS_4_WAY, ARROWS_5_WAY, DECISION_SHAPES, DECISION_SYMBOLS, DIRECTIONS_3_WAY, DIRECTIONS_4_WAY, EFFORT, HARVEY_BALLS, HEARTS, MONEY, PAIN, PRIORITY, PRIORITY_HML, PROGRESS, RYG, RYGB, RYGG, SIGNAL, SKI, STAR_RATING, VCR, WEATHER.

ColumnType String False

The system-defined column type.

The allowed values are AUTO_NUMBER, CREATED_BY, CREATED_DATE, MODIFIED_BY, MODIFIED_DATE.

TagsAggregate String True

Defines system tags for the column, used to indicate roles in features like Gantt charts or calendars (for example, 'gantt_duration').

Width Integer False

The pixel width used to display the column in the sheet's user interface.

Format String False

The applied formatting settings for the column, such as text alignment or date format.

FilterType String True

Specifies the type of filter applied to the column, with options such as 'list' for predefined values or 'custom' for user-defined filters.

Locked Boolean False

Indicates whether the column is locked, preventing edits by all users except the owner or admin.

LockedForUser Boolean False

Indicates whether the column is locked for the current user based on their permissions.

SheetId String False

The unique identifier of the sheet to which this column belongs.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454