Skip to content

Asana: Get a team's custom fields

Asana customFieldSettings.getCustomFieldSettingsForTeam: arguments, response, policy and SDK examples.

← Custom field settings operations · Get started

Operation asana.getcustomfieldsettingsforteam

Provider route: GET /teams/{team_gid}/custom_field_settings. 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["customFieldSettings"]["getCustomFieldSettingsForTeam"]>[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.customFieldSettings.getCustomFieldSettingsForTeam(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.custom_field_settings.get_custom_field_settings_for_team(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.team_gidstringRequired within parent
queryModelOptionalExpand Get a team’s custom fields — request body — query

Referenced models: Get a team’s custom fields — 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 project — response body — data data — Custom Field Setting Response
$ (allOf 2)ModelAll variants applyExpand Get a goal’s custom fields — response body — data, next page

Referenced models: Add a custom field to a project — response body — data data — Custom Field Setting Response, Get a goal’s custom fields — response body — data, next page

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

Add a custom field to a project — response body — data data — Custom Field Setting Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Add a custom field to a project — response body — data data gid, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).projectJSONOptional
$ (allOf 2).project (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).project (allOf 2)objectAll variants apply*Deprecated: new integrations should prefer the `parent` field.* The id of the project that this custom field settings refers to.
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 project or portfolio.
Read only: true
$ (allOf 2).parentJSONOptional
$ (allOf 2).parent (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).parent (allOf 2)objectAll variants applyThe parent to which the custom field is applied. This can be a project or portfolio and indicates that the tasks or projects that the parent contains may be given custom field values for this custom field.
Read only: true
$ (allOf 2).custom_fieldJSONOptional
$ (allOf 2).custom_field (allOf 1)ModelAll variants applyExpand Get a custom field — response body — data data — Custom Field Response
$ (allOf 2).custom_field (allOf 2)objectAll variants applyThe custom field that is applied to the `parent`.
Read only: true

Referenced models: Add a custom field to a project — response body — data data gid, resource type, Get a custom field — response body — data data — Custom Field Response, Search projects in a workspace — response body — data data item

Get a goal's custom fields — response body — data, next page
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Add a custom field to a project — response body — data data — sdk__Custom Field 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 project — response body — data data — sdk__Custom Field Setting Response

Get a team's custom fields — request body — query
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
opt_prettybooleanOptional
opt_fieldsarrayOptional
opt_fields[]stringEach itemOne of: custom_field, custom_field.asana_created_field, custom_field.created_by, custom_field.created_by.name, custom_field.currency_code, custom_field.custom_label, custom_field.custom_label_position, custom_field.date_value, custom_field.date_value.date, custom_field.date_value.date_time, custom_field.default_access_level, custom_field.description, 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.format, custom_field.has_notifications_enabled, custom_field.html_text_value, custom_field.id_prefix, custom_field.input_restrictions, custom_field.is_formula_field, custom_field.is_global_to_workspace, custom_field.is_lookup_field, custom_field.is_value_read_only, 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.people_value, custom_field.people_value.name, custom_field.precision, custom_field.privacy_setting, custom_field.reference_value, custom_field.reference_value.name, custom_field.representation_type, custom_field.resource_subtype, custom_field.text_value, custom_field.type, is_important, parent, parent.name, parent.resource_subtype, project, project.name, project.resource_subtype
Add a custom field to a project — response body — data data gid, resource type
FieldTypePresenceDescription and constraints
$objectRootCustom Fields Settings objects represent the many-to-many join of the Custom Field and Project as well as stores information that is 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 custom field — response body — data data — Custom Field Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a custom field — response body — data / data / format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference
$ (allOf 2)objectAll variants apply
$ (allOf 2).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
$ (allOf 2).id_prefixJSONOptional
$ (allOf 2).id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
$ (allOf 2).id_prefix (anyOf 2)nullAlternative
$ (allOf 2).input_restrictionsarrayOptional
$ (allOf 2).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
$ (allOf 2).is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
$ (allOf 2).is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
$ (allOf 2).is_value_read_onlybooleanOptional*Conditional*. This flag describes whether a custom field is read only.
$ (allOf 2).created_byJSONOptional
$ (allOf 2).created_by (anyOf 1)JSONAlternative
$ (allOf 2).created_by (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).created_by (anyOf 1) (allOf 2)JSONAll variants apply
$ (allOf 2).created_by (anyOf 2)nullAlternative
$ (allOf 2).people_valuearrayOptional*Conditional*. Only relevant for custom fields of type `people`. This array of [compact user](/reference/users) objects reflects the values of a `people` custom field.
$ (allOf 2).people_value[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).reference_valuearrayOptional*Conditional*. Only relevant for custom fields of type `reference`. This array of objects reflects the values of a `reference` custom field.
$ (allOf 2).reference_value[]ModelEach itemExpand Get objects via typeahead — response body — data data item
$ (allOf 2).html_text_valueJSONOptional
$ (allOf 2).html_text_value (anyOf 1)stringAlternative*Conditional*. Only relevant for custom fields of type `text`. This is the HTML representation of the text value of a custom field, corresponding to the `text_value` plain-text field. See [rich text](/docs/rich-text#reading-rich-text).
Read only: true
$ (allOf 2).html_text_value (anyOf 2)nullAlternative
$ (allOf 2).privacy_settingstringOptionalThe privacy setting of the custom field. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*
Known values: public_with_guests, public, private
$ (allOf 2).default_access_levelstringOptionalThe default access level when inviting new members to the custom field. This isn't applied when the `privacy_setting` is `private`, or the user is a guest. For local fields in a project or portfolio, the user must additionally have permission to modify the container itself.
Known values: admin, editor, user
$ (allOf 2).resource_subtypestringOptionalThe 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

Referenced models: Get objects via typeahead — response body — data data item, Get a custom field — response body — data / data / format: currency, identifier, percentage, custom, duration, none, type: text, enum, multi enum, number, date, people, reference, Get users in a team — response body — data data item

Get objects via typeahead — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
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 object.

SDK function policy ID: asana.getcustomfieldsettingsforteam. Catalog operation: asana:getCustomFieldSettingsForTeam. 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: ["teams: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.