Get organization custom fields count in a module

GET {{baseUrl}}/api/v1/customFieldCount?module=<String>

This API returns the custom field count allowed and available in a module.

OAuth Scope

  • Desk.basic.READ

Request Params

KeyDatatypeRequiredDescription
modulestringName of the module whose allowed and available custom fields must be fetched. Values allowed are tickets, contacts, accounts, tasks, calls, events, timeEntry, products, and contracts.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;customFieldCounts&quot;:[{&quot;types&quot;:[&quot;Text&quot;,&quot;PickList&quot;,&quot;Email&quot;,&quot;Phone&quot;,&quot;Website&quot;],&quot;maximumLimit&quot;:100,&quot;available&quot;:100,&quot;type&quot;:&quot;Varchar&quot;},{&quot;types&quot;:[&quot;Textarea&quot;,&quot;Multiselect&quot;],&quot;maximumLimit&quot;:30,&quot;available&quot;:30,&quot;type&quot;:&quot;Text&quot;},{&quot;types&quot;:[&quot;Number&quot;],&quot;maximumLimit&quot;:20,&quot;available&quot;:20,&quot;type&quot;:&quot;Integer&quot;},{&quot;types&quot;:[&quot;Percent&quot;,&quot;Decimal&quot;,&quot;Currency&quot;],&quot;maximumLimit&quot;:20,&quot;available&quot;:20,&quot;type&quot;:&quot;Double&quot;},{&quot;types&quot;:[&quot;Date&quot;],&quot;maximumLimit&quot;:20,&quot;available&quot;:20,&quot;type&quot;:&quot;Date&quot;},{&quot;types&quot;:[&quot;DateTime&quot;],&quot;maximumLimit&quot;:20,&quot;available&quot;:20,&quot;type&quot;:&quot;DateTime&quot;},{&quot;types&quot;:[&quot;Checkbox&quot;],&quot;maximumLimit&quot;:20,&quot;available&quot;:20,&quot;type&quot;:&quot;Boolean&quot;},{&quot;types&quot;:[&quot;Text&quot;,&quot;Website&quot;,&quot;Email&quot;,&quot;Number&quot;,&quot;Phone&quot;,&quot;Percent&quot;,&quot;Decimal&quot;],&quot;maximumLimit&quot;:10,&quot;available&quot;:10,&quot;type&quot;:&quot;DESK_SEARCHABLE_CTEXT_OEK&quot;},{&quot;maximumLimit&quot;:10,&quot;available&quot;:10,&quot;type&quot;:&quot;Formula&quot;}],&quot;totalAvailableCount&quot;:230}