Tables

CustomFieldTableSetting

Property	Type	Description
`gid`	string	Globally unique identifier of the resource, as a string.
`resource_type`	string	The base type of this resource.
`custom_field`	object	The custom field that is applied to the table.
`custom_field.gid`	string	Globally unique identifier of the resource, as a string.
`custom_field.resource_type`	string	The base type of this resource.
`custom_field.name`	string	The name of the custom field.
`custom_field.type`	string	Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values. Click to show all enum values `date` `enum` `multi_enum` `number` `people` `reference` `text`
`custom_field.enum_options[]`	[object]	Conditional. Only relevant for custom fields of type `enum` or `multi_enum`. This array specifies the possible values which an `enum` custom field can adopt. To modify the enum options, refer to working with enum options.
`custom_field.enum_options[].gid`	string	Globally unique identifier of the resource, as a string.
`custom_field.enum_options[].resource_type`	string	The base type of this resource.
`custom_field.enum_options[].name`	string	The name of the enum option.
`custom_field.enum_options[].enabled`	boolean	Whether or not the enum option is a selectable value for the custom field.
`custom_field.enum_options[].color`	string	The color of the enum option. Defaults to `none`.
`custom_field.enabled`	boolean	Conditional. This field applies only to custom field values and is not available for custom field definitions. Determines if the custom field is enabled or not. For more details, see the Custom Fields documentation.
`custom_field.representation_type`	string	This field tells the type of the custom field. Click to show all enum values `custom_id` `date` `enum` `formula` `multi_enum` `number` `people` `reference` `text`
`custom_field.id_prefix`	string	This field is the unique custom ID string for the custom field.
`custom_field.input_restrictions[]`	[string]	Conditional. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value. Click to show all enum values `goal` `portfolio` `project` `task`
`custom_field.is_formula_field`	boolean	Conditional. This flag describes whether a custom field is a formula custom field.
`custom_field.is_lookup_field`	boolean	Conditional. This flag describes whether a custom field is a lookup custom field.
`custom_field.date_value`	object	Conditional. Only relevant for custom fields of type `date`. This object reflects the chosen date (and optionally, time) value of a `date` custom field. If no date is selected, the value of `date_value` will be `null`.
`custom_field.date_value.date`	string	A string representing the date in YYYY-MM-DD format.
`custom_field.date_value.date_time`	string	A string representing the date in ISO 8601 format. If no time value is selected, the value of `date-time` will be `null`.
`custom_field.enum_value`	object	Conditional. Only relevant for custom fields of type `enum`. This object is the chosen value of an `enum` custom field.
`custom_field.enum_value.gid`	string	Globally unique identifier of the resource, as a string.
`custom_field.enum_value.resource_type`	string	The base type of this resource.
`custom_field.enum_value.name`	string	The name of the enum option.
`custom_field.enum_value.enabled`	boolean	Whether or not the enum option is a selectable value for the custom field.
`custom_field.enum_value.color`	string	The color of the enum option. Defaults to `none`.
`custom_field.multi_enum_values[]`	[object]	Conditional. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
`custom_field.multi_enum_values[].gid`	string	Globally unique identifier of the resource, as a string.
`custom_field.multi_enum_values[].resource_type`	string	The base type of this resource.
`custom_field.multi_enum_values[].name`	string	The name of the enum option.
`custom_field.multi_enum_values[].enabled`	boolean	Whether or not the enum option is a selectable value for the custom field.
`custom_field.multi_enum_values[].color`	string	The color of the enum option. Defaults to `none`.
`custom_field.number_value`	number	Conditional. This number is the value of a `number` custom field.
`custom_field.text_value`	string	Conditional. This string is the value of a `text` custom field.
`custom_field.display_value`	string	A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.
`is_important`	boolean	`is_important` is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a table.

Example JSON for CustomFieldTableSetting:

{
  "gid": "12345",
  "resource_type": "custom_field_setting",
  "custom_field": {
    "gid": "12345",
    "resource_type": "custom_field",
    "name": "Status",
    "type": "example string",
    "enum_options": [
      {
        "gid": "12345",
        "resource_type": "enum_option",
        "name": "Low",
        "enabled": true,
        "color": "blue"
      }
    ],
    "enabled": true,
    "representation_type": "number",
    "id_prefix": "ID",
    "input_restrictions": [
      "task"
    ],
    "is_formula_field": false,
    "is_lookup_field": false,
    "date_value": {
      "date": "2024-08-23",
      "date_time": "2024-08-23T22:00:00.000Z"
    },
    "enum_value": {
      "gid": "12345",
      "resource_type": "enum_option",
      "name": "Low",
      "enabled": true,
      "color": "blue"
    },
    "multi_enum_values": [
      {
        "gid": "12345",
        "resource_type": "enum_option",
        "name": "Low",
        "enabled": true,
        "color": "blue"
      }
    ],
    "number_value": 5.2,
    "text_value": "Some Value",
    "display_value": "blue"
  },
  "is_important": true
}

TableCompact

Property	Type	Description
`gid`	string	Globally unique identifier of the resource, as a string.
`resource_type`	string	The base type of this resource.
`name`	string	The name of the table.

Example JSON for TableCompact:

{
  "gid": "12345",
  "resource_type": "table",
  "name": "Vendor contracts"
}

Table

Property	Type	Description
`gid`	string	Globally unique identifier of the resource, as a string.
`resource_type`	string	The base type of this resource.
`name`	string	The name of the table.
`modified_at`	string (date-time)	The time at which this table was last modified.
`created_at`	string (date-time)	The time at which this resource was created.
`workspace`	object	Create-only. The workspace or organization this table is associated with. Once created, tables cannot be moved to a different workspace. This attribute can only be specified at creation time.
`workspace.gid`	string	Globally unique identifier of the resource, as a string.
`workspace.resource_type`	string	The base type of this resource.
`workspace.name`	string	The name of the workspace.
`custom_field_settings[]`	[object]	Array of custom field definitions that are enabled for the table. These represent which custom fields are available to records in the table, but do not include any values.
`custom_field_settings[].gid`	string	Globally unique identifier of the resource, as a string.
`custom_field_settings[].resource_type`	string	The base type of this resource.
`custom_field_settings[].custom_field`	object	The custom field that is applied to the table.
`custom_field_settings[].custom_field.gid`	string	Globally unique identifier of the resource, as a string.
`custom_field_settings[].custom_field.resource_type`	string	The base type of this resource.
`custom_field_settings[].custom_field.name`	string	The name of the custom field.
`custom_field_settings[].custom_field.type`	string	Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values. Click to show all enum values `date` `enum` `multi_enum` `number` `people` `reference` `text`
`custom_field_settings[].custom_field.enum_options[]`	[object]	Conditional. Only relevant for custom fields of type `enum` or `multi_enum`. This array specifies the possible values which an `enum` custom field can adopt. To modify the enum options, refer to working with enum options.
`custom_field_settings[].custom_field.enum_options[].gid`	string	Globally unique identifier of the resource, as a string.
`custom_field_settings[].custom_field.enum_options[].resource_type`	string	The base type of this resource.
`custom_field_settings[].custom_field.enum_options[].name`	string	The name of the enum option.
`custom_field_settings[].custom_field.enum_options[].enabled`	boolean	Whether or not the enum option is a selectable value for the custom field.
`custom_field_settings[].custom_field.enum_options[].color`	string	The color of the enum option. Defaults to `none`.
`custom_field_settings[].custom_field.enabled`	boolean	Conditional. This field applies only to custom field values and is not available for custom field definitions. Determines if the custom field is enabled or not. For more details, see the Custom Fields documentation.
`custom_field_settings[].custom_field.representation_type`	string	This field tells the type of the custom field. Click to show all enum values `custom_id` `date` `enum` `formula` `multi_enum` `number` `people` `reference` `text`
`custom_field_settings[].custom_field.id_prefix`	string	This field is the unique custom ID string for the custom field.
`custom_field_settings[].custom_field.input_restrictions[]`	[string]	Conditional. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value. Click to show all enum values `goal` `portfolio` `project` `task`
`custom_field_settings[].custom_field.is_formula_field`	boolean	Conditional. This flag describes whether a custom field is a formula custom field.
`custom_field_settings[].custom_field.is_lookup_field`	boolean	Conditional. This flag describes whether a custom field is a lookup custom field.
`custom_field_settings[].custom_field.date_value`	object	Conditional. Only relevant for custom fields of type `date`. This object reflects the chosen date (and optionally, time) value of a `date` custom field. If no date is selected, the value of `date_value` will be `null`.
`custom_field_settings[].custom_field.date_value.date`	string	A string representing the date in YYYY-MM-DD format.
`custom_field_settings[].custom_field.date_value.date_time`	string	A string representing the date in ISO 8601 format. If no time value is selected, the value of `date-time` will be `null`.
`custom_field_settings[].custom_field.enum_value`	object	Conditional. Only relevant for custom fields of type `enum`. This object is the chosen value of an `enum` custom field.
`custom_field_settings[].custom_field.enum_value.gid`	string	Globally unique identifier of the resource, as a string.
`custom_field_settings[].custom_field.enum_value.resource_type`	string	The base type of this resource.
`custom_field_settings[].custom_field.enum_value.name`	string	The name of the enum option.
`custom_field_settings[].custom_field.enum_value.enabled`	boolean	Whether or not the enum option is a selectable value for the custom field.
`custom_field_settings[].custom_field.enum_value.color`	string	The color of the enum option. Defaults to `none`.
`custom_field_settings[].custom_field.multi_enum_values[]`	[object]	Conditional. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
`custom_field_settings[].custom_field.multi_enum_values[].gid`	string	Globally unique identifier of the resource, as a string.
`custom_field_settings[].custom_field.multi_enum_values[].resource_type`	string	The base type of this resource.
`custom_field_settings[].custom_field.multi_enum_values[].name`	string	The name of the enum option.
`custom_field_settings[].custom_field.multi_enum_values[].enabled`	boolean	Whether or not the enum option is a selectable value for the custom field.
`custom_field_settings[].custom_field.multi_enum_values[].color`	string	The color of the enum option. Defaults to `none`.
`custom_field_settings[].custom_field.number_value`	number	Conditional. This number is the value of a `number` custom field.
`custom_field_settings[].custom_field.text_value`	string	Conditional. This string is the value of a `text` custom field.
`custom_field_settings[].custom_field.display_value`	string	A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.
`custom_field_settings[].is_important`	boolean	`is_important` is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a table.
`default_access_level`	string	The default access level for users who join or are added as members of the table. Click to show all enum values `admin` `commenter` `editor` `viewer`

Example JSON for Table:

{
  "gid": "12345",
  "resource_type": "table",
  "name": "Vendor contracts",
  "modified_at": "2012-02-22T02:06:58.147Z",
  "created_at": "2012-02-22T02:06:58.147Z",
  "workspace": {
    "gid": "12345",
    "resource_type": "workspace",
    "name": "My Company Workspace"
  },
  "custom_field_settings": [
    {
      "gid": "12345",
      "resource_type": "custom_field_setting",
      "custom_field": {
        "gid": "12345",
        "resource_type": "custom_field",
        "name": "Status",
        "type": "example string",
        "enum_options": [
          {
            "gid": "12345",
            "resource_type": "enum_option",
            "name": "Low",
            "enabled": true,
            "color": "blue"
          }
        ],
        "enabled": true,
        "representation_type": "number",
        "id_prefix": "ID",
        "input_restrictions": [
          "task"
        ],
        "is_formula_field": false,
        "is_lookup_field": false,
        "date_value": {
          "date": "2024-08-23",
          "date_time": "2024-08-23T22:00:00.000Z"
        },
        "enum_value": {
          "gid": "12345",
          "resource_type": "enum_option",
          "name": "Low",
          "enabled": true,
          "color": "blue"
        },
        "multi_enum_values": [
          {
            "gid": "12345",
            "resource_type": "enum_option",
            "name": "Low",
            "enabled": true,
            "color": "blue"
          }
        ],
        "number_value": 5.2,
        "text_value": "Some Value",
        "display_value": "blue"
      },
      "is_important": true
    }
  ],
  "default_access_level": "viewer"
}