Base URL and authentication
x-api-key header.
Field types
Option values match ignoring case. A field’s key and type cannot change after you create it. A workspace has at most 200 fields, and a select field at most 500 options.
Define a field
{fieldId} also accepts the key, so GET /v1/custom-fields/markets/options lists that field’s options.
Change options
PATCH /v1/custom-fields/{fieldId} with options replaces the whole list, in display order:
- An entry with
idkeeps that option and renames it tovalue. Projects that chose it keep their choice. - An entry without
idadds an option. - Options you leave out are removed, along with every project’s choice of them.
Set values on a project
PUT /v1/projects/{projectId}/custom-fields sets the fields you name, keyed by field key or ID. null clears a value, and fields you leave out keep theirs:
GET on the same path, lists the values set on the project:
400 with invalid_body; the message names the field, for example customFields.markets: "Mars" is not an option of this field.
Set values when you create a project
POST /v1/projects accepts the same customFields object, so a request’s project gets its reference and links in the call that creates it, including from a project template:

