Sign in
Custom fields

Get a workspace's custom fields

<b>Required scope: </b><code>custom_fields:read</code>

Returns a list of the compact representation of all of the custom fields in a workspace.

get/workspaces/{workspace_gid}/custom_fields

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/workspaces/{workspace_gid}/custom_fields
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token, scopes: custom_fields:read)

Query parameters

opt_fieldsstring[]

This 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. Properties can include nested fields. To learn more, see the input/output options guide.

Response

Successfully retrieved all custom fields for the given workspace.

Example response

{
  "data": [
    {
      "gid": "12345",
      "resource_type": "custom_field",
      "name": "Status",
      "enum_options": [
        {
          "gid": "12345",
          "resource_type": "enum_option",
          "name": "Low",
          "enabled": true,
          "color": "blue"
        }
      ],
      "enabled": true,
      "representation_type": "number",
      "id_prefix": "ID",
      "input_restrictions": [
        "task"
      ],
      "date_value": {
        "date": "2024-08-23",
        "date_time": "2024-08-23T22:00:00.000Z"
      },
      "enum_value": {
        "gid": "12345",
        "resource_type": "enum_option",
        "name": "Low",
        "enabled": true,
        "color": "blue"
      },
      "multi_enum_values": [
        {
          "gid": "12345",
          "resource_type": "enum_option",
          "name": "Low",
          "enabled": true,
          "color": "blue"
        }
      ],
      "number_value": 5.2,
      "text_value": "Some Value",
      "display_value": "blue",
      "description": "Development team priority",
      "precision": 2,
      "format": "custom",
      "currency_code": "EUR",
      "custom_label": "gold pieces",
      "custom_label_position": "suffix",
      "is_global_to_workspace": true,
      "has_notifications_enabled": true,
      "asana_created_field": "priority",
      "created_by": {
        "gid": "12345",
        "resource_type": "user",
        "name": "Greg Sanchez"
      },
      "people_value": [
        {
          "gid": "12345",
          "resource_type": "user",
          "name": "Greg Sanchez"
        }
      ],
      "reference_value": [
        {
          "gid": "12345",
          "resource_type": "task",
          "name": "Bug Task"
        }
      ],
      "html_text_value": "<body>Some Value</body>",
      "privacy_setting": "public_with_guests",
      "default_access_level": "user",
      "resource_subtype": "text"
    }
  ],
  "next_page": {
    "offset": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "path": "/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "uri": "https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.