Get organization fields in a module
GET {{baseUrl}}/api/v1/organizationFields?module=<String>
This API fetches fields in a module
OAuth Scope
Desk.basic.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
module | string | the module name with in which search to be done. Value may be tickets, contacts , accounts ,tasks , calls , events, timeEntry,products, contracts | |
apiNames | string | Key that fetches only the fields whose apiNames are given. Multiple values can be passed, with commas for separation. | |
departmentId | string | Key that fetches only the fields for the given departmentId. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"displayLabel":"Department","apiName":"departmentId","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000353","type":"LookUp","maxLength":50,"isMandatory":false},{"displayLabel":"Account Name","apiName":"accountId","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000355","type":"LookUp","maxLength":300,"isMandatory":false},{"displayLabel":"Contact Name","apiName":"contactId","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000357","type":"LookUp","maxLength":300,"isMandatory":true},{"displayLabel":"Email","apiName":"email","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000359","type":"Email","maxLength":120,"isMandatory":false},{"displayLabel":"Phone","apiName":"phone","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000361","type":"Phone","maxLength":120,"isMandatory":false},{"displayLabel":"Subject","apiName":"subject","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000363","type":"Text","maxLength":255,"isMandatory":true},{"displayLabel":"Description","apiName":"description","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000365","type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Status","allowedValues":[{"statusType":"Open","value":"Open"},{"statusType":"Open","value":"Open_july"},{"statusType":"Open","value":"Open_newDept"},{"statusType":"On Hold","value":"On Hold"},{"statusType":"Open","value":"Escalated"},{"statusType":"Closed","value":"Closed1"},{"statusType":"Open","value":"Closed"},{"statusType":"Closed","value":"newDeptClosed"},{"statusType":"Closed","value":"julyDeptClosed"},{"statusType":"Closed","value":"julyDeptClosed1"}],"apiName":"status","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000367","type":"Picklist","maxLength":120,"isMandatory":true},{"displayLabel":"Product Name","apiName":"productId","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000369","type":"LookUp","maxLength":120,"isMandatory":false},{"displayLabel":"Case Owner","apiName":"assigneeId","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000371","type":"LookUp","maxLength":120,"isMandatory":false},{"displayLabel":"Category","allowedValues":[{"value":"General"},{"value":"Defects"},{"value":"ManojKumar"}],"apiName":"category","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000421","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Sub Category","allowedValues":[{"value":"Sub General"},{"value":"Sub Defects"},{"value":"Sub Defects1235"}],"apiName":"subCategory","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000423","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Due Date","apiName":"dueDate","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000405","type":"DateTime","maxLength":300,"isMandatory":false},{"displayLabel":"Priority","allowedValues":[{"value":"-None-"},{"value":"High"},{"value":"Medium"},{"value":"Low"}],"apiName":"priority","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000407","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Mode","allowedValues":[{"value":"Phone"},{"value":"Email"},{"value":"Web"},{"value":"Twitter"},{"value":"Facebook"},{"value":"Chat"},{"value":"Forums"},{"value":"Feedback Widget"}],"apiName":"channel","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000409","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Is Overdue","apiName":"Is Overdue","isCustomField":false,"defaultValue":"true","showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000411","type":"Boolean","maxLength":50,"isMandatory":false},{"displayLabel":"Is Escalated","apiName":"Is Escalated","isCustomField":false,"defaultValue":"true","showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000413","type":"Boolean","maxLength":50,"isMandatory":false},{"displayLabel":"Classification","allowedValues":[{"value":"-None-"},{"value":"Question"},{"value":"Problem"},{"value":"Feature"},{"value":"Others"}],"apiName":"classification","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000415","type":"Picklist","maxLength":120,"isMandatory":false},{"displayLabel":"Resolution","apiName":"resolution","isCustomField":false,"showToHelpCenter":true,"isEncryptedField":false,"id":"4000000000417","type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Sample Text Field","apiName":"cf_sample_text_field","isCustomField":false,"toolTipType":"placeHolder","showToHelpCenter":true,"isEncryptedField":false,"toolTip":"Sample Text Field","id":"4000000000447","type":"Textarea","maxLength":1000000,"isMandatory":false},{"displayLabel":"Large Text Field","apiName":"cf_large_text_field","isCustomField":true,"i18NLabel":"Large Text Field","name":"LargeText field","isEncryptedField":false,"id":"4000000000449","type":"LargeText","maxLength":16000000,"isMandatory":false,"properties":{"translatable":true}}]}