get
https://{youraccountname}.api-us1.com/api/3/dealCustomFieldMeta
Every custom field defined on deals: the deal fields, each with its type and label.
To retrieve custom deal fields, the following permissions are required.
- Deal permission: the user should have permission to manage deals.
- Pipeline-specific permission: the user should have permission to manage the pipeline that the deal belongs to. If the user does not have the permission to manage the pipeline, limited deal data are returned with only
id,title, andisDisabledset to1.
{
"dealCustomFieldMeta": [
{
"id": "1",
"fieldLabel": "Text Example",
"fieldType": "text",
"fieldOptions": null,
"fieldDefault": 1,
"fieldDefaultCurrency": null,
"isFormVisible": 0,
"displayOrder": 1,
"personalization": "",
"knownFieldId": null,
"hideFieldFlag": 0,
"createdTimestamp": "2019-04-23 15:34:00",
"updatedTimestamp": "2019-05-03 15:16:51",
"links": {
"dealCustomFieldData": "https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData"
}
},
{
"id": "2",
"fieldLabel": "Multiple Choice Example",
"fieldType": "multiselect",
"fieldOptions": [
"Option 1",
"Option 2",
"Option 3"
],
"fieldDefault": 1,
"fieldDefaultCurrency": null,
"isFormVisible": 0,
"displayOrder": 2,
"personalization": "",
"knownFieldId": null,
"hideFieldFlag": 0,
"createdTimestamp": "2019-04-23 15:34:00",
"updatedTimestamp": "2019-05-03 15:16:51",
"links": {
"dealCustomFieldData": "https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData"
}
}
]
}