Skip to main content
Server path: /asana-customization | Type: Application | PCID required: Yes

Tools

ToolDescription
asana_customization_create_allocationCreate an allocation
asana_customization_create_budgetCreate a budget
asana_customization_create_custom_fieldCreate a custom field
asana_customization_create_enum_option_for_custom_fieldCreate an enum option
asana_customization_create_rateCreate a rate
asana_customization_create_roleCreate a role
asana_customization_delete_allocationDelete an allocation
asana_customization_delete_budgetDelete a budget
asana_customization_delete_custom_fieldDelete a custom field
asana_customization_delete_rateDelete a rate
asana_customization_delete_roleDelete a role
asana_customization_get_allocationGet an allocation
asana_customization_get_allocationsGet multiple allocations
asana_customization_get_budgetGet a budget
asana_customization_get_budgetsGet all budgets
asana_customization_get_custom_fieldGet a custom field
asana_customization_get_custom_field_settings_for_goalGet a goal’s custom fields
asana_customization_get_custom_field_settings_for_portfolioGet a portfolio’s custom fields
asana_customization_get_custom_field_settings_for_projectGet a project’s custom fields
asana_customization_get_custom_field_settings_for_teamGet a team’s custom fields
asana_customization_get_custom_fields_for_workspaceGet a workspace’s custom fields
asana_customization_get_custom_typeGet a custom type
asana_customization_get_custom_typesGet all custom types associated with an object
asana_customization_get_rateGet a rate
asana_customization_get_ratesGet multiple rates
asana_customization_get_roleGet a role
asana_customization_get_rolesGet multiple roles
asana_customization_insert_enum_option_for_custom_fieldReorder a custom field’s enum
asana_customization_update_allocationUpdate an allocation
asana_customization_update_budgetUpdate a budget
asana_customization_update_custom_fieldUpdate a custom field
asana_customization_update_enum_optionUpdate an enum option
asana_customization_update_rateUpdate a rate
asana_customization_update_roleUpdate a role

asana_customization_create_allocation

Create an allocation Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_create_budget

Create a budget Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
dataobjectNoThe data value

asana_customization_create_custom_field

Create a custom field Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_create_enum_option_for_custom_field

Create an enum option Parameters:
ParameterTypeRequiredDefaultDescription
custom_field_gidstringYesGlobally unique identifier for the custom field.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_create_rate

Create a rate Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoA generic Asana Resource, containing a globally unique identifier.

asana_customization_create_role

Create a role Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_delete_allocation

Delete an allocation Parameters:
ParameterTypeRequiredDefaultDescription
allocation_gidstringYesGlobally unique identifier for the allocation.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_customization_delete_budget

Delete a budget Parameters:
ParameterTypeRequiredDefaultDescription
budget_gidstringYesGlobally unique identifier for the budget.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_customization_delete_custom_field

Delete a custom field Parameters:
ParameterTypeRequiredDefaultDescription
custom_field_gidstringYesGlobally unique identifier for the custom field.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_customization_delete_rate

Delete a rate Parameters:
ParameterTypeRequiredDefaultDescription
rate_gidstringYesGlobally unique identifier for the rate.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_customization_delete_role

Delete a role Parameters:
ParameterTypeRequiredDefaultDescription
role_gidstringYesGlobally unique identifier for the role.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_customization_get_allocation

Get an allocation Parameters:
ParameterTypeRequiredDefaultDescription
allocation_gidstringYesGlobally unique identifier for the allocation.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_allocations

Get multiple allocations Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
parentstringNoGlobally unique identifier for the project to filter allocations by.
assigneestringNoGlobally unique identifier for the user or placeholder the allocation is assigned to.
workspacestringNoGlobally unique identifier for the workspace.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_budget

Get a budget Parameters:
ParameterTypeRequiredDefaultDescription
budget_gidstringYesGlobally unique identifier for the budget.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_budgets

Get all budgets Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
parentstringYesGlobally unique identifier for the budget’s parent object. This currently can only be a project.

asana_customization_get_custom_field

Get a custom field Parameters:
ParameterTypeRequiredDefaultDescription
custom_field_gidstringYesGlobally unique identifier for the custom field.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_custom_field_settings_for_goal

Get a goal’s custom fields Parameters:
ParameterTypeRequiredDefaultDescription
goal_gidstringYesGlobally unique identifier for the goal.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_custom_field_settings_for_portfolio

Get a portfolio’s custom fields Parameters:
ParameterTypeRequiredDefaultDescription
portfolio_gidstringYesGlobally unique identifier for the portfolio.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_custom_field_settings_for_project

Get a project’s custom fields Parameters:
ParameterTypeRequiredDefaultDescription
project_gidstringYesGlobally unique identifier for the project.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_custom_field_settings_for_team

Get a team’s custom fields Parameters:
ParameterTypeRequiredDefaultDescription
team_gidstringYesGlobally unique identifier for the team.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_custom_fields_for_workspace

Get a workspace’s custom fields Parameters:
ParameterTypeRequiredDefaultDescription
workspace_gidstringYesGlobally unique identifier for the workspace or organization.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_custom_type

Get a custom type Parameters:
ParameterTypeRequiredDefaultDescription
custom_type_gidstringYesGlobally unique identifier for the custom type.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_custom_types

Get all custom types associated with an object Parameters:
ParameterTypeRequiredDefaultDescription
projectstringYesGlobally unique identifier for the project, which is used as a filter when retrieving all custom types.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_rate

Get a rate Parameters:
ParameterTypeRequiredDefaultDescription
rate_gidstringYesGlobally unique identifier for the rate.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_rates

Get multiple rates Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
parentstringNoGlobally unique identifier for project.
resourcestringNoGlobally unique identifier for user or placeholder.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_role

Get a role Parameters:
ParameterTypeRequiredDefaultDescription
role_gidstringYesGlobally unique identifier for the role.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_get_roles

Get multiple roles Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
workspacestringNoThe workspace or organization to filter roles on.
archivedbooleanNoOnly return projects whose archived field takes on the value of this parameter.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_customization_insert_enum_option_for_custom_field

Reorder a custom field’s enum Parameters:
ParameterTypeRequiredDefaultDescription
custom_field_gidstringYesGlobally unique identifier for the custom field.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_update_allocation

Update an allocation Parameters:
ParameterTypeRequiredDefaultDescription
allocation_gidstringYesGlobally unique identifier for the allocation.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_update_budget

Update a budget Parameters:
ParameterTypeRequiredDefaultDescription
budget_gidstringYesGlobally unique identifier for the budget.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_update_custom_field

Update a custom field Parameters:
ParameterTypeRequiredDefaultDescription
custom_field_gidstringYesGlobally unique identifier for the custom field.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_customization_update_enum_option

Update an enum option Parameters:
ParameterTypeRequiredDefaultDescription
enum_option_gidstringYesGlobally unique identifier for the enum option.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoEnum options are the possible values which an enum custom field can adopt. An enum custom field must contain at least 1 enum option but no more than 500. You can add enum options to a custom field by using the POST /custom_fields/custom_field_gid/enum_options endpoint. It is not possible to remove or delete an enum option. Instead, enum options can be disabled by updating the enabled field to false with the PUT /enum_options/enum_option_gid endpoint. Other attributes can be updated similarly. On creation of an enum option, enabled is always set to true, meaning the enum option is a selectable value for the custom field. Setting enabled=false is equivalent to “trashing” the enum option in the Asana web app within the “Edit Fields” dialog. The enum option will no longer be selectable but, if the enum option value was previously set within a task, the task will retain the value. Enum options are an ordered list and by default new enum options are inserted at the end. Ordering in relation to existing enum options can be specified on creation by using insert_before or insert_after to reference an existing enum option. Only one of insert_before and insert_after can be provided when creating a new enum option. An enum options list can be reordered with the POST /custom_fields/custom_field_gid/enum_options/insert endpoint.

asana_customization_update_rate

Update a rate Parameters:
ParameterTypeRequiredDefaultDescription
rate_gidstringYesGlobally unique identifier for the rate.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoA generic Asana Resource, containing a globally unique identifier.

asana_customization_update_role

Update a role Parameters:
ParameterTypeRequiredDefaultDescription
role_gidstringYesGlobally unique identifier for the role.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value