Asana

Get a portfolio's custom fields

GET

/portfolios/{portfolio_gid}/custom_field_settings

Custom Field Settings

Returns a list of all of the custom fields settings on a portfolio, in compact form.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.asana.com/api/1.0/portfolios//custom_field_settings'

Response Example

200 - Example 1

{
  "data": [
    {
      "gid": "12345",
      "resource_type": "task",
      "custom_field": {
        "gid": "12345",
        "resource_type": "task",
        "display_value": "blue",
        "enabled": true,
        "enum_options": [
          {
            "gid": "12345",
            "resource_type": "task",
            "color": "blue",
            "enabled": true,
            "name": "Low"
          }
        ],
        "name": "Status",
        "number_value": 5.2,
        "resource_subtype": "text",
        "text_value": "Some Value",
        "type": "text",
        "currency_code": "EUR",
        "custom_label": "gold pieces",
        "custom_label_position": "suffix",
        "description": "Development team priority",
        "format": "custom",
        "has_notifications_enabled": true,
        "is_global_to_workspace": true,
        "precision": 2,
        "created_by": {
          "gid": "12345",
          "resource_type": "task",
          "name": "Greg Sanchez"
        },
        "enum_value": {
          "gid": "12345",
          "resource_type": "task",
          "color": "blue",
          "enabled": true,
          "name": "Low"
        },
        "multi_enum_values": [
          {
            "gid": "12345",
            "resource_type": "task",
            "color": "blue",
            "enabled": true,
            "name": "Low"
          }
        ]
      },
      "is_important": false,
      "parent": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Stuff to buy"
      },
      "project": {
        "gid": "12345",
        "resource_type": "task",
        "name": "Stuff to buy"
      }
    }
  ]
}

Request

Path Params

portfolio_gid

string

required

Responses

🟢200Successfully retrieved custom field settings objects for a portfolio.

application/json

Body

data

array[object (CustomFieldSettingResponse) {6}]

optional

custom_field

object

read-onlyoptional

The custom field that is applied to the parent.

is_important

boolean

read-onlyoptional

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.

Example:

false

parent

object

read-onlyoptional

The 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.

project

object

read-onlyoptional

Deprecated: new integrations should prefer the parent field. The id of the project that this custom field settings refers to.

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2022-09-13 02:00:31

Remove users from a portfolio

Get a project's custom fields