# Updated Custom Fields

**URL:** <https://forum.asana.com/t/updated-custom-fields/55153>\
**Category:** API & Developers\
**Created:** [15 July 2019 23:46 UTC](https://forum.asana.com/t/updated-custom-fields/55153 "2019-07-15T23:46:07Z")\
**Posts on this page:** 20\
**Page:** 1

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [15 July 2019 23:46 UTC](https://forum.asana.com/t/updated-custom-fields/55153/1 "2019-07-15T23:46:07Z")

</div>

Continuing the discussion from [Updated Custom Fields!](https://forum.asana.com/t/updated-custom-fields/55140):

@Joe_Trollo @Jeff_Schneider @Matt_Bramlage  
Does this Asana change have any ramifications for the API?

For example, when we programmatically create a custom field, will we be able to specify whether it should be a workspace-wide or project-specific custom field?

---

<div class="post-metadata">

**Author:** ![Ross\_Grambo](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/ross_grambo/32/68568_2.png) [@Ross\_Grambo](https://forum.asana.com/u/Ross_Grambo)\
**Post date:** [16 July 2019 20:42 UTC](https://forum.asana.com/t/updated-custom-fields/55153/2 "2019-07-16T20:42:49Z")

</div>

Hey @Phil_Seeman,

Yes, you will be in charge of it being global or not.

We’re still working on getting some docs up for it, but the param is named `is_global_to_workspace`. It’s opt\_in for GET and can _Not_ be used in POST.

Let me know if you have any issues with it!

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [16 July 2019 21:07 UTC](https://forum.asana.com/t/updated-custom-fields/55153/3 "2019-07-16T21:07:54Z")

</div>

Cool, thanks @Ross_Grambo.

I’m needing to determine if my current code will be OK or now needs modification. Obviously I can test it but wondering if you can comment:

Will the **/workspaces/{id}/custom\_fields** endpoint return only the workspace-global fields, or it will include all project-specific non-global fields as well?

---

<div class="post-metadata">

**Author:** ![Ross\_Grambo](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/ross_grambo/32/68568_2.png) [@Ross\_Grambo](https://forum.asana.com/u/Ross_Grambo)\
**Post date:** [16 July 2019 22:01 UTC](https://forum.asana.com/t/updated-custom-fields/55153/4 "2019-07-16T22:01:56Z")

</div>

Hey @Phil_Seeman,

The `/workspaces/{id}/custom_fields` endpoint will not return project specific ones.

I was wrong earlier. The `is_global_to_workspace` is read only. It looks like you create project specific ones with `/projects/:id/addCustomFieldSetting`.

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [16 July 2019 23:16 UTC](https://forum.asana.com/t/updated-custom-fields/55153/5 "2019-07-16T23:16:25Z")

</div>

@Ross_Grambo  
I don’t get how that would work. That endpoint requires that one supply the ID of an existing custom field. There’s no (documented) ability to supply new custom field info (name, type) in that endpoint.

This update to how custom fields work is a BREAKING CHANGE for external developers, so I am hoping you can rush out some documentation ASAP on all of the API-related changes. 🙏

**EDIT:**  
More critically for me right now than how to create a project-specific custom field, is _ **how do I query for project-specific custom fields for a given project??** _

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [17 July 2019 00:38 UTC](https://forum.asana.com/t/updated-custom-fields/55153/6 "2019-07-17T00:38:23Z")

</div>

@Ross_Grambo I thought it might help to elaborate on why it’s a **Breaking Change**. Here’s the one use case I know of from Flowsana.

At one point in my code, I need to add a custom field to a project if it’s not already there.

I query for all custom fields in the current workspace. If a field with the correct name and type already exists, I use it. If it does not exist, I add a new field of that name and type.

But now with this model change, what if a project-specific field of that name and type exists in my target project (or for that matter, in _ **any** _ project in the workspace)? I’m assuming my “add” operation will fail, a state which I’m not currently expecting because it wasn’t possible before. (But will it fail?)

And let’s say the “add” operation doesn’t fail, and my new field is created. Then my next step is to add the new field to the target project’s custom field settings. But again, what if a field of that name and type already exists in that project? Then I’m assuming my “add to settings” operation will fail - again a state which I’m not currently expecting. (But will it fail? And if not, does that mean there are two fields of the same name and type in the project?)

Hopefully the above gives you a good example of my questions and my confusion as to how things work now.

cc: @Joe_Trollo

---

<div class="post-metadata">

**Author:** ![Ross\_Grambo](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/ross_grambo/32/68568_2.png) [@Ross\_Grambo](https://forum.asana.com/u/Ross_Grambo)\
**Post date:** [17 July 2019 18:07 UTC](https://forum.asana.com/t/updated-custom-fields/55153/7 "2019-07-17T18:07:49Z")

</div>

Hey @Phil_Seeman,

I opened up the api team’s design docs. It looks I left out an important snippet.

Calls to `POST /projects/:id/addCustomFieldSetting` may now specify a JSON blob in the custom\_field parameter instead of an ID. This will create a custom field local to that container.

```auto
{ "data": {
	"custom_field": {
		"name": "hello",
		"resource_subtype": "text"
	}
}}

```

In your example, when a project already has a local field named “foo” and we’re adding a global one named “foo”. The add operation would not fail. You would add an additional custom field added to the project with the same name and type. One would be global and one would be local.

I wouldn’t call this a breaking change, because all functionality with global fields will continue to work in the same way. In order for an app to have their custom fields integrate nicely with local custom fields (like avoid duplicates), then they have to add additional functionality.

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [17 July 2019 18:30 UTC](https://forum.asana.com/t/updated-custom-fields/55153/8 "2019-07-17T18:30:16Z")

</div>

> [@Ross\_Grambo](#):
>
> may now specify a JSON blob in the custom\_field parameter instead of an ID. This will create a custom field local to that container.

Ah, OK, cool!

I still have this question, though:  
_ **How do I query for project-specific custom fields for a given project??** _

> [@Ross\_Grambo](#):
>
> The add operation would not fail. You would add an additional custom field added to the project with the same name and type. One would be global and one would be local.

Whoa, really? OK. I guess you’re right then that technically it’s not a breaking change because existing code won’t fail where it worked before; but I’m really surprised this is the new behavior (I know that’s not API-related but rather is a more core product-design decision). I would bet money that this behavior of allowing two identical fields, one local and one global, in the same project will cause user confusion and Asana support-team nightmares down the line. But that’s just me. 🙂

---

<div class="post-metadata">

**Author:** ![Ross\_Grambo](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/ross_grambo/32/68568_2.png) [@Ross\_Grambo](https://forum.asana.com/u/Ross_Grambo)\
**Post date:** [17 July 2019 19:03 UTC](https://forum.asana.com/t/updated-custom-fields/55153/9 "2019-07-17T19:03:25Z")

</div>

@Phil_Seeman,

I completely agree with you. I had the same concern, but after talking to a few people here, there’s good reasoning why this is the case. Hopefully the UI will offer a nice way to distinguish global vs local.

> [@Phil\_Seeman](#):
>
> _ **How do I query for project-specific custom fields for a given project??** _

You’ll have to `opt_fields` the `custom_field_settings` on the `project`.

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [17 July 2019 19:39 UTC](https://forum.asana.com/t/updated-custom-fields/55153/10 "2019-07-17T19:39:41Z")

</div>

Thanks for the query solution, Ross!

> [@Ross\_Grambo](#):
>
> there’s good reasoning why this is the case.

We’ll see how good you all consider it after you see the tech support metrics on it haha!

---

<div class="post-metadata">

**Author:** ![Bastien\_Siebman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/bastien_siebman/32/172354_2.png) [@Bastien\_Siebman](https://forum.asana.com/u/Bastien_Siebman)\
**Post date:** [19 July 2019 11:19 UTC](https://forum.asana.com/t/updated-custom-fields/55153/11 "2019-07-19T11:19:27Z")

</div>

Eagerly waiting for the official doc and rollout date as I will be heavily impacted with [iDO Tools - Improve Asana with our tools and automations](https://minimalist-work.com/asana/custom-fields)

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [19 July 2019 12:55 UTC](https://forum.asana.com/t/updated-custom-fields/55153/12 "2019-07-19T12:55:00Z")

</div>

> [@Bastien\_Siebman](#):
>
> and rollout date

It’s already rolled out!

---

<div class="post-metadata">

**Author:** ![Bastien\_Siebman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/bastien_siebman/32/172354_2.png) [@Bastien\_Siebman](https://forum.asana.com/u/Bastien_Siebman)\
**Post date:** [19 July 2019 12:59 UTC](https://forum.asana.com/t/updated-custom-fields/55153/13 "2019-07-19T12:59:30Z")

</div>

The API is already rolled out then? Damn my tool must be broken then!

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [19 July 2019 13:04 UTC](https://forum.asana.com/t/updated-custom-fields/55153/14 "2019-07-19T13:04:00Z")

</div>

It’s not really “broken” per se, it’s just not reporting on project-specific custom fields. To get those, you have to query each project as Ross described here:

> [@Ross\_Grambo](#):
>
> You’ll have to `opt_fields` the `custom_field_settings` on the `project` .

---

<div class="post-metadata">

**Author:** ![Bastien\_Siebman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/bastien_siebman/32/172354_2.png) [@Bastien\_Siebman](https://forum.asana.com/u/Bastien_Siebman)\
**Post date:** [19 July 2019 15:27 UTC](https://forum.asana.com/t/updated-custom-fields/55153/15 "2019-07-19T15:27:08Z")

</div>

Yes, it is broken in the sense that it does not list all custom fields anymore 😛

---

<div class="post-metadata">

**Author:** ![Phil\_Seeman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/phil_seeman/32/81525_2.png) [@Phil\_Seeman](https://forum.asana.com/u/Phil_Seeman)\
**Post date:** [19 July 2019 16:38 UTC](https://forum.asana.com/t/updated-custom-fields/55153/16 "2019-07-19T16:38:47Z")

</div>

I have an easy way to make it not broken - just rename it to “Global Custom Field Explorer”. All fixed! 😆

---

<div class="post-metadata">

**Author:** ![Kothar](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/kothar/32/25241_2.png) [@Kothar](https://forum.asana.com/u/Kothar)\
**Post date:** [24 August 2022 21:31 UTC](https://forum.asana.com/t/updated-custom-fields/55153/17 "2022-08-24T21:31:19Z")

</div>

I realise I’m very late to this party, but I have been working with non-global custom fields this week and have run into some problems. The documentation is still not up to date regarding how these work with the API.

> [@Ross\_Grambo](#):
>
> Calls to `POST /projects/:id/addCustomFieldSetting` may now specify a JSON blob in the custom\_field parameter instead of an ID. This will create a custom field local to that container.

I have noticed that certain fields are not applied to newly created project-local fields, notably `format`~~(they seem to work fine for global fields):~~

EDIT: This does not apply to project local fields only, creating new `number` custom fields as global fields also fails to store or update the `format` attribute and related fields.

```auto
            "precision": 1,
            "format": "percentage",
            "resource_subtype": "number"
        }
    }
}

RESULT
{
    "data": {
        "gid": "1202858477963949",
        ...
        "custom_field": {
            "gid": "1202858477963950",
            "resource_type": "custom_field",
            "created_by": ...
            "resource_subtype": "number",
            "type": "number",
            "name": "Local Number test",
            "precision": 1
        },
        ...
    }
}

---

GET /custom_fields/1202858477963950?opt_fields=format,resource_subtype,precision

RESULT
{
    "data": {
        "gid": "1202858477963950",
        "precision": 1,
        "format": "none",
        "resource_subtype": "number"
    }
}

```

This also applies to `currency_code`, `custom_label` and `custom_label_position` (since the `format` defaults to `none`)

Additionally, the `format` field cannot be updated via `PUT` request to the custom field endpoint, either for local or global fields.

Since there is no official documentation other than this thread which describes the intended behaviour, I can’t really say this is a bug, but it does seem like something is missing from the custom fields API implementation.

* * *

Edited to add that this is not specific to project-local custom fields, but also applies to creation of new global custom fields.

---

<div class="post-metadata">

**Author:** ![Bastien\_Siebman](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/bastien_siebman/32/172354_2.png) [@Bastien\_Siebman](https://forum.asana.com/u/Bastien_Siebman)\
**Post date:** [27 August 2022 19:35 UTC](https://forum.asana.com/t/updated-custom-fields/55153/18 "2022-08-27T19:35:30Z")

</div>

@Kothar great to see you here! are you actively working on your tool? It is a famous tool in the community! ❤ 💪

---

<div class="post-metadata">

**Author:** ![Kothar](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/kothar/32/25241_2.png) [@Kothar](https://forum.asana.com/u/Kothar)\
**Post date:** [28 August 2022 09:09 UTC](https://forum.asana.com/t/updated-custom-fields/55153/19 "2022-08-28T09:09:18Z")

</div>

Hi @Bastien_Siebman - yes, I finally found the time and energy to make some updates!

Mostly trying to catch up on new features Ditto didn’t support yet, notably Date and Multi-Enum fields are now working correctly.

---

<div class="post-metadata">

**Author:** ![system](https://sea2.discourse-cdn.com/asana/user_avatar/forum.asana.com/system/32/276370_2.png) [@system](https://forum.asana.com/u/system)\
**Post date:** [30 May 2025 19:03 UTC](https://forum.asana.com/t/updated-custom-fields/55153/20 "2025-05-30T19:03:36Z")

</div>

Closed on 30 May 2025 19:03 UTC


