Skip to content

Asana: Tables schemas

21 Asana schemas with complete fields and constraints.

← Tables operations · All schemas

Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference
$ (allOf 2)objectAll variants apply
$ (allOf 2).resource_subtypestringRequired within parentThe type of the custom field. Must be one of the given values.
One of: text, enum, multi_enum, number, date, people, reference

Referenced models: Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference

Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference
$ (allOf 2)objectAll variants apply
$ (allOf 2).workspacestringRequired within parent*Create-Only* The workspace to create a custom field in.
$ (allOf 2).owned_by_appbooleanOptional*Allow-listed*. Instructs the API that this Custom Field is app-owned. This parameter is allow-listed to specific apps at this point in time. For apps that are not allow-listed, providing this parameter will result in a `403 Forbidden`.
$ (allOf 2).people_valuearrayOptional*Conditional*. Only relevant for custom fields of type `people`. This array of user GIDs, emails, or the string "me", reflects the users to be written to a `people` custom field. Note that *write* operations will replace existing users (if any) in the custom field with the users specified in this array.
$ (allOf 2).people_value[]stringEach itemA string identifying a user. This can either be the string "me", an email, or the gid of a user.
$ (allOf 2).reference_valuearrayOptional*Conditional*. Only relevant for custom fields of type `reference`. This array of GIDs reflects the objects to be written to a `reference` custom field. Note that *write* operations will replace existing objects (if any) in the custom field with the objects specified in this array.
$ (allOf 2).reference_value[]stringEach itemThe GID of an object.

Referenced models: Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference

Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference type: text, enum, multi enum, number, date, people, reference
$ (allOf 2)objectAll variants apply
$ (allOf 2).descriptionstringOptional[Opt In](/docs/inputoutput-options). The description of the custom field.
$ (allOf 2).enum_optionsarrayOptional*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](/reference/createenumoptionforcustomfield).
$ (allOf 2).enum_options[]ModelEach itemExpand Create an enum option — response body — data data — Enum Option
$ (allOf 2).precisionintegerOptionalOnly relevant for custom fields of type `Number`. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive.
For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%.
The identifier format will always have a precision of 0.
$ (allOf 2).formatstringOptionalThe format of this custom field.
One of: currency, identifier, percentage, custom, duration, none
$ (allOf 2).currency_codeJSONOptional
$ (allOf 2).currency_code (anyOf 1)stringAlternativeISO 4217 currency code to format this custom field. This will be null if the `format` is not `currency`.
$ (allOf 2).currency_code (anyOf 2)nullAlternative
$ (allOf 2).custom_labelJSONOptional
$ (allOf 2).custom_label (anyOf 1)stringAlternativeThis is the string that appears next to the custom field value. This will be null if the `format` is not `custom`.
$ (allOf 2).custom_label (anyOf 2)nullAlternative
$ (allOf 2).custom_label_positionJSONOptional
$ (allOf 2).custom_label_position (anyOf 1)stringAlternativeOnly relevant for custom fields with `custom` format. This depicts where to place the custom label. This will be null if the `format` is not `custom`.
One of: prefix, suffix, null
$ (allOf 2).custom_label_position (anyOf 2)nullAlternative
$ (allOf 2).is_global_to_workspacebooleanOptionalThis flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true.
Read only: true
$ (allOf 2).has_notifications_enabledbooleanOptional*Conditional*. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field.
$ (allOf 2).asana_created_fieldJSONOptional
$ (allOf 2).asana_created_field (anyOf 1)stringAlternative*Conditional*. A unique identifier to associate this field with the template source of truth.
Read only: true
One of: a_v_requirements, account_name, actionable, align_shipping_link, align_status, allotted_time, appointment, approval_stage, approved, article_series, board_committee, browser, campaign_audience, campaign_project_status, campaign_regions, channel_primary, client_topic_type, complete_by, contact, contact_email_address, content_channels, content_channels_needed, content_stage, content_type, contract, contract_status, cost, creation_stage, creative_channel, creative_needed, creative_needs, data_sensitivity, deal_size, delivery_appt, delivery_appt_date, department, department_responsible, design_request_needed, design_request_type, discussion_category, do_this_task, editorial_content_status, editorial_content_tag, editorial_content_type, effort, effort_level, est_completion_date, estimated_time, estimated_value, expected_cost, external_steps_needed, favorite_idea, feedback_type, financial, funding_amount, grant_application_process, hiring_candidate_status, idea_status, ids_link, ids_patient_link, implementation_stage, insurance, interview_area, interview_question_score, itero_scan_link, job_s_applied_to, lab, launch_status, lead_status, localization_language, localization_market_team, localization_status, meeting_minutes, meeting_needed, minutes, mrr, must_localize, name_of_foundation, need_to_follow_up, next_appointment, next_steps_sales, num_people, number_of_user_reports, office_location, onboarding_activity, owner, participants_needed, patient_date_of_birth, patient_email, patient_phone, patient_status, phone_number, planning_category, point_of_contact, position, post_format, prescription, priority, priority_level, product, product_stage, progress, project_size, project_status, proposed_budget, publish_status, reason_for_scan, referral, request_type, research_status, responsible_department, responsible_team, risk_assessment_status, room_name, sales_counterpart, sentiment, shipping_link, social_channels, stage, status, status_design, status_of_initiative, system_setup, task_progress, team, team_marketing, team_responsible, time_it_takes_to_complete_tasks, timeframe, treatment_type, type_work_requests_it, use_agency, user_name, vendor_category, vendor_type, word_count, null
$ (allOf 2).asana_created_field (anyOf 2)nullAlternative

Referenced models: Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference type: text, enum, multi enum, number, date, people, reference, Create an enum option — response body — data data — Enum Option

Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference type: text, enum, multi enum, number, date, people, reference

FieldTypePresenceDescription and constraints
$objectRootCustom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom field.
typestringOptional*Deprecated: new integrations should prefer the resource_subtype field.* The type of the custom field. Must be one of the given values.

Read only: true
One of: text, enum, multi_enum, number, date, people, reference
enum_optionsarrayOptional*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](/reference/createenumoptionforcustomfield).
enum_options[]ModelEach itemExpand Create an enum option — response body — data data — Enum Option
enabledbooleanOptional*Conditional*. This field applies only to [custom field values](/docs/custom-fields-guide#/accessing-custom-field-values-on-tasks-or-projects) and is not available for [custom field definitions](/docs/custom-fields-guide#/accessing-custom-field-definitions).
Determines if the custom field is enabled or not. For more details, see the [Custom Fields documentation](/docs/custom-fields-guide#/enabled-and-disabled-values).
Read only: true
representation_typestringOptionalThis field tells the type of the custom field.
Read only: true
One of: text, enum, multi_enum, number, date, people, formula, custom_id, reference
id_prefixJSONOptional
id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
id_prefix (anyOf 2)nullAlternative
input_restrictionsarrayOptional
input_restrictions[]stringEach item*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.
One of: task, project, portfolio, goal
is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
date_valueJSONOptional
date_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data date value date, date time
date_value (anyOf 2)nullAlternative
enum_valueJSONOptional
enum_value (anyOf 1)JSONAlternative
enum_value (anyOf 1) (allOf 1)ModelAll variants applyExpand Create an enum option — response body — data data — Enum Option
enum_value (anyOf 1) (allOf 2)objectAll variants apply*Conditional*. Only relevant for custom fields of type `enum`. This object is the chosen value of an `enum` custom field.
enum_value (anyOf 2)nullAlternative
multi_enum_valuesarrayOptional*Conditional*. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
multi_enum_values[]ModelEach itemExpand Create an enum option — response body — data data — Enum Option
number_valueJSONOptional
number_value (anyOf 1)numberAlternative*Conditional*. This number is the value of a `number` custom field.
number_value (anyOf 2)nullAlternative
text_valueJSONOptional
text_value (anyOf 1)stringAlternative*Conditional*. This string is the value of a `text` custom field.
text_value (anyOf 2)nullAlternative
display_valueJSONOptional
display_value (anyOf 1)stringAlternativeA 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.
Read only: true
display_value (anyOf 2)nullAlternative

Referenced models: Create an enum option — response body — data data — Enum Option, Get a custom field — response body — data data date value date, date time

Add a custom field to a table — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
custom_fieldJSONRequired within parent
custom_field (oneOf 1)stringAlternativeThe custom field to associate with this container.
custom_field (oneOf 2)ModelAlternativeExpand Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference
is_importantbooleanOptionalWhether this field should be considered important to this container (for instance, to display in the list view of items in the container).
insert_beforestringOptionalA gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified.
insert_afterstringOptionalA gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added. `insert_before` and `insert_after` parameters cannot both be specified.

Referenced models: Add a custom field to a table — request body — body / data / custom_field / format: currency, identifier, percentage, custom, duration, none, resource subtype: text, enum, multi enum, number, date, people, reference, type: text, enum, multi enum, number, date, people, reference

Add a custom field to a table — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add a custom field to a table — response body — data data — sdk__Custom Field Table Setting Response

Referenced models: Add a custom field to a table — response body — data data — sdk__Custom Field Table Setting Response

Add a custom field to a table — response body — data data custom field

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.
The custom field that is applied to the table.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom field.
typestringOptional*Deprecated: new integrations should prefer the resource_subtype field.* The type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true
enum_optionsarrayOptional*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](/reference/createenumoptionforcustomfield).
enum_options[]ModelEach itemExpand Get a custom field — response body — data data enum options item
enabledbooleanOptional*Conditional*. This field applies only to [custom field values](/docs/custom-fields-guide#/accessing-custom-field-values-on-tasks-or-projects) and is not available for [custom field definitions](/docs/custom-fields-guide#/accessing-custom-field-definitions).
Determines if the custom field is enabled or not. For more details, see the [Custom Fields documentation](/docs/custom-fields-guide#/enabled-and-disabled-values).
Read only: true
representation_typestringOptionalThis field tells the type of the custom field.
Known values: text, enum, multi_enum, number, date, people, formula, custom_id, reference
Read only: true
id_prefixJSONOptional
id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
id_prefix (anyOf 2)nullAlternative
input_restrictionsarrayOptional
input_restrictions[]stringEach item*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.
Known values: task, project, portfolio, goal
is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
date_valueJSONOptional
date_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data date value date, date time
date_value (anyOf 2)nullAlternative
enum_valueJSONOptional
enum_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data enum value color, enabled, gid, name, resource type
enum_value (anyOf 2)nullAlternative
multi_enum_valuesarrayOptional*Conditional*. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
multi_enum_values[]ModelEach itemExpand Get a custom field — response body — data data enum options item
number_valueJSONOptional
number_value (anyOf 1)JSONAlternative
number_value (anyOf 1) (anyOf 1)numberAlternative*Conditional*. This number is the value of a `number` custom field.
number_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_value (anyOf 2)nullAlternative
text_valueJSONOptional
text_value (anyOf 1)stringAlternative*Conditional*. This string is the value of a `text` custom field.
text_value (anyOf 2)nullAlternative
display_valueJSONOptional
display_value (anyOf 1)stringAlternativeA 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.
Read only: true
display_value (anyOf 2)nullAlternative

Referenced models: Get a custom field — response body — data data date value date, date time, Get a custom field — response body — data data enum options item, Get a custom field — response body — data data enum value color, enabled, gid, name, resource type

Add a custom field to a table — response body — data data gid, resource type

FieldTypePresenceDescription and constraints
$objectRootA *custom field table setting* represents the many-to-many join of a custom field and a table, storing information relevant to that particular pairing.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true

Add a custom field to a table — response body — data data — Custom Field Table Setting Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Add a custom field to a table — response body — data data gid, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).custom_fieldJSONOptional
$ (allOf 2).custom_field (allOf 1)ModelAll variants applyExpand Get a membership — response body — data / data / access_level: admin, editor, user parent
$ (allOf 2).custom_field (allOf 2)objectAll variants applyThe custom field that is applied to the table.
Read only: true
$ (allOf 2).is_importantbooleanOptional`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.
Read only: true

Referenced models: Add a custom field to a table — response body — data data gid, resource type, Get a membership — response body — data / data / access_level: admin, editor, user parent

Add a custom field to a table — response body — data data — sdk__Custom Field Table Setting Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *custom field table setting* represents the many-to-many join of a custom field and a table, storing information relevant to that particular pairing.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
custom_fieldModelOptionalExpand Add a custom field to a table — response body — data data custom field
is_importantbooleanOptional`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.
Read only: true

Referenced models: Add a custom field to a table — response body — data data custom field

Create a table — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get tables in a workspace — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).workspacestringRequired within parent*Create-only*. The workspace or organization in which this table will be created. Once created, tables cannot be moved to a different workspace.

Referenced models: Get tables in a workspace — response body — data, next page data item

Get a table — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: created_at, custom_field_settings, custom_field_settings.custom_field, custom_field_settings.custom_field.date_value, custom_field_settings.custom_field.date_value.date, custom_field_settings.custom_field.date_value.date_time, custom_field_settings.custom_field.display_value, custom_field_settings.custom_field.enabled, custom_field_settings.custom_field.enum_options, custom_field_settings.custom_field.enum_options.color, custom_field_settings.custom_field.enum_options.enabled, custom_field_settings.custom_field.enum_options.name, custom_field_settings.custom_field.enum_value, custom_field_settings.custom_field.enum_value.color, custom_field_settings.custom_field.enum_value.enabled, custom_field_settings.custom_field.enum_value.name, custom_field_settings.custom_field.id_prefix, custom_field_settings.custom_field.input_restrictions, custom_field_settings.custom_field.is_formula_field, custom_field_settings.custom_field.is_lookup_field, custom_field_settings.custom_field.multi_enum_values, custom_field_settings.custom_field.multi_enum_values.color, custom_field_settings.custom_field.multi_enum_values.enabled, custom_field_settings.custom_field.multi_enum_values.name, custom_field_settings.custom_field.name, custom_field_settings.custom_field.number_value, custom_field_settings.custom_field.representation_type, custom_field_settings.custom_field.text_value, custom_field_settings.custom_field.type, custom_field_settings.is_important, default_access_level, modified_at, name, workspace, workspace.name

Get a table — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a table — response body — data data — sdk__Table Response

Referenced models: Get a table — response body — data data — sdk__Table Response

Get a table — response body — data data custom field settings item

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *custom field table setting* represents the many-to-many join of a custom field and a table, storing information relevant to that particular pairing.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
custom_fieldModelOptionalExpand Add a custom field to a table — response body — data data custom field
is_importantbooleanOptional`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.
Read only: true

Referenced models: Add a custom field to a table — response body — data data custom field

Get a table — response body — data data workspace

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
*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.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.

Get a table — response body — data data — Table Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get tables in a workspace — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).modified_atstringOptionalThe time at which this table was last modified.
Format: date-time
Read only: true
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).workspaceJSONOptional
$ (allOf 2).workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).workspace (allOf 2)objectAll variants apply*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.
Read only: true
$ (allOf 2).custom_field_settingsarrayOptionalArray 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.
Read only: true
$ (allOf 2).custom_field_settings[]ModelEach itemExpand Add a custom field to a table — response body — data data — Custom Field Table Setting Response
$ (allOf 2).default_access_levelstringOptionalThe default access level for users who join or are added as members of the table.
Known values: admin, editor, commenter, viewer

Referenced models: Add a custom field to a table — response body — data data — Custom Field Table Setting Response, Get tables in a workspace — response body — data, next page data item, Update a workspace — request body — body data

Get a table — response body — data data — sdk__Table Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *table* is a container for structured records (rows), with columns defined by custom field settings.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the table.
modified_atstringOptionalThe time at which this table was last modified.
Format: date-time
Read only: true
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
workspaceModelOptionalExpand Get a table — response body — data data workspace
custom_field_settingsarrayOptionalArray 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.
Read only: true
custom_field_settings[]ModelEach itemExpand Get a table — response body — data data custom field settings item
default_access_levelstringOptionalThe default access level for users who join or are added as members of the table.
Known values: admin, editor, commenter, viewer

Referenced models: Get a table — response body — data data custom field settings item, Get a table — response body — data data workspace

Get a table's custom field settings — tables get Custom Field Settings For Table — request body — query

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
limitintegerOptionalMinimum: 1
Maximum: 100
offsetstringOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: custom_field, custom_field.date_value, custom_field.date_value.date, custom_field.date_value.date_time, custom_field.display_value, custom_field.enabled, custom_field.enum_options, custom_field.enum_options.color, custom_field.enum_options.enabled, custom_field.enum_options.name, custom_field.enum_value, custom_field.enum_value.color, custom_field.enum_value.enabled, custom_field.enum_value.name, custom_field.id_prefix, custom_field.input_restrictions, custom_field.is_formula_field, custom_field.is_lookup_field, custom_field.multi_enum_values, custom_field.multi_enum_values.color, custom_field.multi_enum_values.enabled, custom_field.multi_enum_values.name, custom_field.name, custom_field.number_value, custom_field.representation_type, custom_field.text_value, custom_field.type, is_important, offset, path, uri

Get a table's custom field settings — tables get Custom Field Settings For Table — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Add a custom field to a table — response body — data data — sdk__Custom Field Table Setting Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Add a custom field to a table — response body — data data — sdk__Custom Field Table Setting Response

Get tables in a workspace — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a table — response body — data data — sdk__Table Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a table — response body — data data — sdk__Table Response

Get tables in a workspace — response body — data, next page data item

FieldTypePresenceDescription and constraints
$objectRootA *table* is a container for structured records (rows), with columns defined by custom field settings.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the table.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.