get_custom_fields
Retrieve custom field definitions for ITM Platform entities (project, task, risk, issue, service, activity, purchase, revenue) to identify names, types, and requirements for DataMart queries.
Instructions
Get the account's custom field definitions for an entity type: project, task, risk, issue, service, activity, purchase, or revenue. Returns Id, BaseId, Name, TypeId, TypeName (Text, Number, Percentage, Date, HTML, RYGList, DropDownList, List), Description, Required.
VALUES live in DataMart under "customFields", keyed by the display Name exactly as returned here (case- and accent-sensitive, may contain trailing spaces). Query via query_datamart, e.g. project {"customFields": 1} or where {"customFields.": ...}. On multilingual accounts the key follows each component's language; fetch definitions per languageId to learn the variant names of the same BaseId. Dropdown values: get_custom_field_options.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"entity": "<entity>"
},
"name": "get_custom_fields"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity | Yes | The entity type whose custom field definitions to retrieve | |
| languageId | No | Language: 1=English, 2=Spanish, 3=Portuguese (default: your user language) |