Smartsheet logo

Objects

Column Object

object

Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated.

Array of objects

Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST.

description
string

Column description.

format
string

The format descriptor (see Formatting). Only returned if the include query string parameter contains format and this column has a non-default format applied to it.

formula
string

The formula for the column, if set.

hidden
boolean

Indicates whether the column is hidden.

id
number

Column Id.

index
number

Column index or position. This number is zero-based.

locked
boolean

Indicates whether the column is locked. In a response, a value of true indicates that the column has been locked by the sheet owner or the admin.

lockedForUser
boolean

Indicates whether the column is locked for the requesting user. This attribute may be present in a response, but cannot be specified in a request.

options
Array of strings

Array of the options available for the column.

primary
boolean

Returned only if the column is the Primary Column (value = true).

symbol
string

When applicable for CHECKBOX or PICKLIST column types. See Symbol Columns.

systemColumnType
string
Enum: "AUTO_NUMBER" "CREATED_BY" "CREATED_DATE" "MODIFIED_BY" "MODIFIED_DATE"
tags
Array of strings

Set of tags to indicate special columns. Each element in the array is set to one of the listed enum values.

Items Enum: "CALENDAR_END_DATE" "CALENDAR_START_DATE" "CARD_DONE" "GANTT_ALLOCATION" "GANTT_ASSIGNED_RESOURCE" "GANTT_DISPLAY_LABEL" "GANTT_DURATION" "GANTT_END_DATE" "GANTT_PERCENT_COMPLETE" "GANTT_PREDECESSOR" "GANTT_START_DATE" "BASELINE_START_DATE" "BASELINE_END_DATE" "BASELINE_VARIANCE"
title
string

Column title.

type
string
Enum: "ABSTRACT_DATETIME" "CHECKBOX" "CONTACT_LIST" "DATE" "DATETIME" "DURATION" "MULTI_CONTACT_LIST" "MULTI_PICKLIST" "PICKLIST" "PREDECESSOR" "TEXT_NUMBER"
validation
boolean

Indicates whether validation has been enabled for the column (value = true).

version
number
  • 0: CONTACT_LIST, PICKLIST, or TEXT_NUMBER.
  • 1: MULTI_CONTACT_LIST.
  • 2: MULTI_PICKLIST.
Enum: 0 1 2
width
number

Display width of the column in pixels.

{
  • "autoNumberFormat": {
    },
  • "contactOptions": [
    ],
  • "description": "string",
  • "format": "string",
  • "formula": "string",
  • "hidden": true,
  • "id": 0,
  • "index": 0,
  • "locked": true,
  • "lockedForUser": true,
  • "options": [
    ],
  • "primary": true,
  • "symbol": "string",
  • "systemColumnType": "AUTO_NUMBER",
  • "tags": [
    ],
  • "title": "string",
  • "type": "ABSTRACT_DATETIME",
  • "validation": true,
  • "version": 0,
  • "width": 0
}

ContactOption Object

email
string

A parsable email address.

name
string

Can be a user's name, display name, or free text.

{
  • "email": "string",
  • "name": "string"
}
➔ Next to Methods