Custom fields

Custom fields add your own data to tasks, such as a client code, a budget or a review date. The REST API returns their values and filters tasks by them.

Read custom field values

Every task carries its custom fields in customFields. Read them from any task endpoint, such as Get a project task by ID.

"customFields": [
  {
    "taskCustomFieldId": 311,
    "fieldName": "Client code",
    "fieldType": "SINGLE_LINE_TEXT",
    "fieldValue": [{ "taskId": 90412, "value": "ACME-07" }],
    "options": []
  }
]

Field	Meaning
`fieldName`	The name shown in Astravue
`fieldType`	The kind of field, listed below
`fieldValue`	The value set on this task
`options`	The choices of a dropdown field

Field types are SINGLE_LINE_TEXT, MULTI_LINE_TEXT, NUMBERS, DATE, PHONE, EMAIL, CHECKBOX, SINGLE_SELECT_DROPDOWN, MULTI_SELECT_DROPDOWN, PERCENTAGE, CURRENCY and URL.

Filter tasks by a custom field

Task and subtask lists accept a customFields query parameter. It takes a JSON object with a list of conditions, matched against the field's name:

{"filters": [{"field": "Client code", "condition": "IS", "value": "ACME-07"}]}

URL-encode it when you send it:

All conditions in the list must match. The supported conditions are in Pagination and filtering.

TIP

Filter on the value exactly as the API returns it in fieldValue. Read one task first to see the format your field uses.

Create fields and set values

The REST API does not create custom fields or set their values. Do that in Astravue, or with the custom field tools of the Astravue MCP server.

API reference

Action	Endpoint
Read values on a task	Get a project task by ID, Get task by ID
Filter project tasks	Get all tasks in a project
Filter personal tasks	Get all tasks
Filter subtasks	Get all subtasks

Read custom field values#

Filter tasks by a custom field#

Create fields and set values#

API reference#

Read custom field values

Filter tasks by a custom field

Create fields and set values

API reference