Entry Type Fields
GET {{host}}/api/rest/v4/schema/entrytypes/{{entryTypeId}}/fieldsReturns all fields fields for a given entry type. Accepts both numerical entryTypeID and apiName.
Params
| Name | Param Type | Data Type | Sample Values | Description |
|---|---|---|---|---|
| entryTypeId | path | int / string | 2013 / interaction | the unique identifier of the entry type |
| editable | query | bool | true | filters editable/non-editable fields |
| entryForm | query | bool | false | filters fields that are presented/not presented on the entry form |
Request
GET {{host}}/api/rest/v4/schema/entrytypes/interaction/fields
Authorization: Bearer {{token}}Response
[
{
"apiName": "Subject",
"fieldType": 1,
"isRequired": true,
"allowDuplicates": true,
"warnOnNearDuplicates": false,
"isMoney": false,
"isMultiSelect": false,
"entryLists": [],
"systemFieldType": 9,
"isKey": false,
"isCalculated": false,
"isAttachment": false,
"isStoreRequestSupported": true,
"id": 2211,
"name": "Subject",
"entryListId": 2013
},
{
"apiName": "Attachments",
"fieldType": 5,
"isRequired": false,
"allowDuplicates": true,
"warnOnNearDuplicates": false,
"isMoney": false,
"isMultiSelect": true,
"entryLists": [
2010
],
"systemFieldType": 10,
"isKey": false,
"isCalculated": false,
"isAttachment": true,
"isStoreRequestSupported": true,
"id": 2212,
"name": "Attachments",
"entryListId": 2013
},
{
"apiName": "Companies",
"fieldType": 5,
"isRequired": false,
"allowDuplicates": true,
"warnOnNearDuplicates": false,
"isMoney": false,
"isMultiSelect": true,
"entryLists": [
2014
],
"systemFieldType": 0,
"isKey": false,
"isCalculated": false,
"isAttachment": false,
"isStoreRequestSupported": true,
"id": 2196,
"name": "Companies",
"entryListId": 2013
},
...
]Errors
Attempting to retrieve non-editable fields present on an entry form
400 Bad Request
{
"message": "Entry form can only have editable fields."
}