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
| Key | Datatype | Required | Description |
|---|---|---|---|
module | string | Name 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
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"customFieldCounts":[{"types":["Text","PickList","Email","Phone","Website"],"maximumLimit":100,"available":100,"type":"Varchar"},{"types":["Textarea","Multiselect"],"maximumLimit":30,"available":30,"type":"Text"},{"types":["Number"],"maximumLimit":20,"available":20,"type":"Integer"},{"types":["Percent","Decimal","Currency"],"maximumLimit":20,"available":20,"type":"Double"},{"types":["Date"],"maximumLimit":20,"available":20,"type":"Date"},{"types":["DateTime"],"maximumLimit":20,"available":20,"type":"DateTime"},{"types":["Checkbox"],"maximumLimit":20,"available":20,"type":"Boolean"},{"types":["Text","Website","Email","Number","Phone","Percent","Decimal"],"maximumLimit":10,"available":10,"type":"DESK_SEARCHABLE_CTEXT_OEK"},{"maximumLimit":10,"available":10,"type":"Formula"}],"totalAvailableCount":230}