Custom Field Settings

Custom fields are attached to a particular project with the Custom Field Settings resource. This resource both represents the many-to-many join of the Custom Field and Project as well as stores information that is relevant to that particular pairing; for instance, the is_important property determines some possible application-specific handling of that custom field (see below)

Custom Field Settings have the following fields:

Field Description
id 1234 Read-only. Globally unique ID of the custom field settings object.
created_at '2012-02-22T02:06:58.147Z' Read-only. The time at which this custom field was created.
is_important false Read-only. is_important is a flag that can be used in application-defined behavior: for instance, in the Asana web application, is_important is used to determine if this custom field on this project is displayed in a column when viewed in the project list.
project { id: 1234, name: 'Bugs' } Read-only. The id of the project that this custom field settings refers to.
custom_field { id: 1646, name: 'Priority', type: 'enum' } Read-only. The custom field that this custom field settings refers to.

QUERY FOR CUSTOM FIELD SETTINGS

GET    /projects/project-id/custom_field_settings

Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, opt_fields and opt_expand can be used to include more data than is returned in the compact representation. See the getting started guide on input/output options for more information.

Parameter Description
project 13579 Required: The ID of the project for which to list custom field settings
# Request
curl -H "Authorization: Bearer <personal_access_token>" \
https://app.asana.com/api/1.0/projects/1331/custom_field_settings

# Response
HTTP/1.1 200
{
  "data": [
    {
      "id": 258147,
      "custom_field": [
        {
          "id": 124578,
          "name": "Priority",
          "type": "enum"
        }
      ],
      "project": [
        {
          "id": 1331,
          "name": "Things to buy"
        }
      ]
    },
    {
      "id": 369852,
      "custom_field": [
        {
          "id": 235689,
          "name": "Cost",
          "type": "enum"
        }
      ],
      "project": [
        {
          "id": 1331,
          "name": "Things to buy"
        }
      ]
    },
    "~..."
  ]
}