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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.table_gid | string | Required within parent | |
query | Model | Optional | Expand 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | array | Optional | |
$ (allOf 1).data[] | Model | Each item | Expand Add a custom field to a table — response body — data data — Custom Field Table Setting Response |
$ (allOf 1).next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
$ (allOf 2) | Model | All variants apply | Expand 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
Schemas
Section titled “Schemas”6 more schemas are linked from the tables above, on the schema pages.
Get goals — response body — data, next page next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | *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).offset | string | Optional | Pagination offset for the request. Read only: true |
$ (anyOf 1).path | string | Optional | A relative path containing the query parameters to fetch for next_page Read only: true |
$ (anyOf 1).uri | string | Optional | A full uri containing the query parameters to fetch for next_page Format: uri Read only: true |
$ (anyOf 2) | null | Alternative |
Add a custom field to a table — response body — data data — Custom Field Table Setting Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Add a custom field to a table — response body — data data gid, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).custom_field | JSON | Optional | |
$ (allOf 2).custom_field (allOf 1) | Model | All variants apply | Expand Get a membership — response body — data / data / access_level: admin, editor, user parent |
$ (allOf 2).custom_field (allOf 2) | object | All variants apply | The custom field that is applied to the table. Read only: true |
$ (allOf 2).is_important | boolean | Optional | `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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Add a custom field to a table — response body — data data — sdk__Custom Field Table Setting Response |
next_page | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
opt_pretty | boolean | Optional | |
limit | integer | Optional | Minimum: 1 Maximum: 100 |
offset | string | Optional | |
opt_fields | array | Optional | |
opt_fields[] | string | Each item | One 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
Get a membership — response body — data / data / access_level: admin, editor, user parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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`. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the custom field. |
type | string | Optional | *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_options | array | Optional | *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[] | Model | Each item | Expand Create an enum option — response body — data data — Enum Option |
enabled | boolean | Optional | *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_type | string | Optional | This 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_prefix | JSON | Optional | |
id_prefix (anyOf 1) | string | Alternative | This field is the unique custom ID string for the custom field. |
id_prefix (anyOf 2) | null | Alternative | |
input_restrictions | array | Optional | |
input_restrictions[] | string | Each 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_field | boolean | Optional | *Conditional*. This flag describes whether a custom field is a formula custom field. |
is_lookup_field | boolean | Optional | *Conditional*. This flag describes whether a custom field is a lookup custom field. |
date_value | JSON | Optional | |
date_value (anyOf 1) | Model | Alternative | Expand Get a custom field — response body — data data date value date, date time |
date_value (anyOf 2) | null | Alternative | |
enum_value | JSON | Optional | |
enum_value (anyOf 1) | JSON | Alternative | |
enum_value (anyOf 1) (allOf 1) | Model | All variants apply | Expand Create an enum option — response body — data data — Enum Option |
enum_value (anyOf 1) (allOf 2) | object | All 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) | null | Alternative | |
multi_enum_values | array | Optional | *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[] | Model | Each item | Expand Create an enum option — response body — data data — Enum Option |
number_value | JSON | Optional | |
number_value (anyOf 1) | JSON | Alternative | |
number_value (anyOf 1) (anyOf 1) | number | Alternative | *Conditional*. This number is the value of a `number` custom field. |
number_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_value (anyOf 2) | null | Alternative | |
text_value | JSON | Optional | |
text_value (anyOf 1) | string | Alternative | *Conditional*. This string is the value of a `text` custom field. |
text_value (anyOf 2) | null | Alternative | |
display_value | JSON | Optional | |
display_value (anyOf 1) | string | Alternative | 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. Read only: true |
display_value (anyOf 2) | null | Alternative |
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
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]