View custom fields of a specific object
You can retrieve the custom fields of a specific object through Settings API. You must specify the object name in the endpoint. See the following example on how to retrieve the custom fields of the Account object.
HTTP request:
GET https://rest.zuora.com/settings/custom-fields/zuora/Account
Response body:
{ "type": "Account", "schema": { "type": "object", "properties": { "Parent__c": { "maxLength": 250, "label": "Parent Company", "type": "string", "description": "Zuora updated description", "createdDate": "2022-04-07T09:18:40.000Z", "updatedDate": "2022-04-07T09:18:40.000Z" }, "AccountOpeningtest__c": { "enum": [ "Quaterly", "Weekly", "Monthly" ], "label": "AccountOpening", "type": "string", "description": "", "default": "Quaterly", "createdDate": "2022-04-18T08:00:45.000Z", "updatedDate": "2022-04-18T08:00:45.000Z" }, "LikesDogs__c": { "enum": [ "Yes", "No" ], "label": "LikesDogs", "type": "string", "description": "Testing description", "default": "Yes", "createdDate": "2022-04-07T09:18:34.000Z", "updatedDate": "2022-04-07T09:18:34.000Z" }, "PaymentCommitmentDate__c": { "format": "date", "label": "Payment Commitment Date", "type": "string", "description": "", "createdDate": "2022-04-07T09:18:43.000Z", "updatedDate": "2022-04-07T09:18:43.000Z" }, "ConversionRate__c": { "maxLength": 100, "label": "Conversion Rate", "type": "string", "description": "", "createdDate": "2022-04-07T09:18:18.000Z", "updatedDate": "2022-04-07T09:18:18.000Z" }, "CollectionsAgent__c": { "maxLength": 255, "label": "CollectionsAgent", "type": "string", "description": "Used for Collections Window module.", "createdDate": "2022-04-07T09:18:15.000Z", "updatedDate": "2022-04-07T09:18:15.000Z" }, "Entity__c": { "enum": [ "US", "UK", "NL", "DE", "AU" ], "label": "Entity", "type": "string", "description": "", "default": "US", "createdDate": "2022-04-07T09:18:25.000Z", "updatedDate": "2022-04-07T09:18:25.000Z" }, "AccountClosing_test_2__c": { "maxLength": 255, "label": "AccountClosing_test_2", "type": "string", "description": "", "createdDate": "2022-04-18T08:00:41.000Z", "updatedDate": "2022-04-18T08:00:41.000Z" }, "InCollections__c": { "enum": [ "False", "True" ], "label": "InCollections", "type": "string", "description": "Used for Collections Window module.", "default": "False", "createdDate": "2022-04-07T09:18:31.000Z", "updatedDate": "2022-04-07T09:18:31.000Z" }, "APM__c": { "enum": [ "True", "False" ], "label": "APM", "type": "string", "description": "Used for Advanced Payment Manager module.", "default": "True", "createdDate": "2022-04-07T09:18:03.000Z", "updatedDate": "2022-04-07T09:18:03.000Z" }, "Support_Hold__c": { "enum": [ "No", "Yes" ], "label": "Support hold", "type": "string", "description": "", "default": "No", "createdDate": "2022-04-07T09:19:06.000Z", "updatedDate": "2022-04-07T09:19:06.000Z" }, "PortalNameURL__c": { "maxLength": 255, "label": "Portal Name (URL)", "type": "string", "description": "", "createdDate": "2022-04-07T09:18:46.000Z", "updatedDate": "2022-04-07T09:18:46.000Z" }, "PortalRequired__c": { "enum": [ "YES", "NO" ], "label": "Portal Required", "type": "string", "description": "", "default": "YES", "createdDate": "2022-04-07T09:18:49.000Z", "updatedDate": "2022-04-07T09:18:49.000Z" }, "PORequired__c": { "enum": [ "YES", "NO" ], "label": "PO Required", "type": "string", "description": "", "default": "YES", "createdDate": "2022-04-07T09:18:36.000Z", "updatedDate": "2022-04-07T09:18:36.000Z" }, "SSPChannel__c": { "enum": [ "Non-Reseller", "Reseller" ], "label": "SSP Channel", "type": "string", "description": "Used for Revenue Recognition", "default": "Non-Reseller", "createdDate": "2022-04-07T09:18:55.000Z", "updatedDate": "2022-04-07T09:18:55.000Z" }, "ExcludeFromEoaStarterBronzeOffer__c": { "enum": [ "No", "Yes" ], "label": "Exclude from EoA Starter Bronze Offer?", "type": "string", "description": "", "default": "No", "createdDate": "2022-04-07T09:18:28.000Z", "updatedDate": "2022-04-07T09:18:28.000Z" }, "AccountCode__c": { "maxLength": 100, "label": "Account Code", "type": "string", "description": "", "createdDate": "2022-04-07T09:18:06.000Z", "updatedDate": "2022-04-07T09:18:06.000Z" }, "CreditHold__c": { "format": "date", "label": "Credit Hold", "type": "string", "description": "Date the Customer was last placed on Credit Hold", "createdDate": "2022-04-07T09:18:21.000Z", "updatedDate": "2022-04-07T09:18:21.000Z" }, "RetryStatus__c": { "maxLength": 255, "label": "Retry Status", "type": "string", "description": "h", "createdDate": "2022-04-07T09:18:52.000Z", "updatedDate": "2022-04-07T09:18:52.000Z" } }, "required": [ "AccountClosing_test_2__c" ], "indexed": [ "APM__c", "AccountClosing_test_2__c", "AccountCode__c", "AccountOpeningtest__c", "ConversionRate__c", "Entity__c", "ExcludeFromEoaStarterBronzeOffer__c", "RetryStatus__c", "SSPChannel__c" ], "additionalProperties": false } }