Custom fields attribute
Workspace-defined pursuit field values, returned with each field's definition ID, name, and type so agents can read and write them in one step.
- Type:
object[] - Data types: Pursuit
- Fields:
custom_fields
Custom fields are the extra pursuit fields your workspace defines in Manage Custom Fields. On a pursuit, custom_fields lists one object per field that has a saved value. Each object carries custom_field_id (the custom field definition GovTribe ID), name, field_type, and value. Fields without a saved value are omitted.
value is stored the same way whether it was entered on the website or written by an agent:
| Field type | Stored value |
|---|---|
text | A string. |
number | A number; decimals are allowed. |
dollar | A number in whole and fractional dollars; decimals are allowed. |
date | An ISO 8601 timestamp in UTC, such as 2026-09-02T00:00:00.000Z. A date-only value written by an agent is stored as UTC midnight. |
MCP search tools return custom_fields only when it is requested in fields_to_return. The Create pursuit and Update pursuit MCP tools accept a custom_fields input of { "custom_field_id": "...", "value": ... } objects. Only the listed fields change, which differs from tag_ids, and a null value clears that field. In CSV exports, each workspace custom field becomes its own column headed by the field name.
Related articles
- Custom field definition: Review the workspace definition each value belongs to.
- Search custom field definitions MCP tool: Resolve
custom_field_idvalues before reading or writing pursuit custom fields. - Update pursuit MCP tool: Set or clear custom field values on a pursuit.
- Create custom pursuit fields: Create and manage the fields your workspace tracks on pursuits.