Skip to content

Asana: Get a table's custom field settings — tables get Custom Field Settings For Table Legacy

Asana tables.getCustomFieldSettingsForTableLegacy: arguments, response, policy and SDK examples.

← Tables operations · Get started

Operation asana.getcustomfieldsettingsfortablelegacy

Provider route: GET /tables/{table_gid}/getCustomFieldSettings. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["tables"]["getCustomFieldSettingsForTableLegacy"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.tables.getCustomFieldSettingsForTableLegacy(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.tables.get_custom_field_settings_for_table_legacy(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.table_gidstringRequired within parent
queryModelOptionalExpand Get a table’s custom field settings — tables get Custom Field Settings For Table — request body — query

Referenced models: Get a table’s custom field settings — tables get Custom Field Settings For Table — request body — query

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataarrayOptional
$ (allOf 1).data[]ModelEach itemExpand Add a custom field to a table — response body — data data — Custom Field Table Setting Response
$ (allOf 1).next_pageModelOptionalExpand Get goals — response body — data, next page next page
$ (allOf 2)ModelAll variants applyExpand Get a table’s custom field settings — tables get Custom Field Settings For Table — response body — data, next page

Referenced models: Get goals — response body — data, next page next page, Add a custom field to a table — response body — data data — Custom Field Table Setting Response, Get a table’s custom field settings — tables get Custom Field Settings For Table — response body — data, next page

6 more schemas are linked from the tables above, on the schema pages.

Get goals — response body — data, next page next page
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative*Conditional*. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
$ (anyOf 1).offsetstringOptionalPagination offset for the request.
Read only: true
$ (anyOf 1).pathstringOptionalA relative path containing the query parameters to fetch for next_page
Read only: true
$ (anyOf 1).uristringOptionalA full uri containing the query parameters to fetch for next_page
Format: uri
Read only: true
$ (anyOf 2)nullAlternative
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

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 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
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
Get a membership — response body — data / data / access_level: admin, editor, user parent
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.

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 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.
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)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)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: Create an enum option — response body — data data — Enum Option, Get a custom field — response body — data data date value date, date time

SDK function policy ID: asana.getcustomfieldsettingsfortablelegacy. Catalog operation: asana:getCustomFieldSettingsForTableLegacy. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["tables:read"]

Official provider source

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.