Skip to main content

View custom fields of a specific object

Zuora

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": {
      "Territory__c": {
        "enum": [
          "Undefined",
          "Central",
          "North",
          "South",
          "East",
          "West"
        ],
        "label": "Territory",
        "type": "string",
        "description": "The territory in which the account belongs in. This is used to enhance reporting.",
        "default": "Undefined",
        "createdDate": "2015-01-09T22:25:30.000Z",
        "updatedDate": "2015-01-09T23:15:22.000Z"
      },
      "SEUseCase__c": {
        "maxLength": 255,
        "label": "SE Use Case",
        "type": "string",
        "description": "Allows the ability to quickly search accounts to demonstrate use cases to clients.",
        "default": "",
        "createdDate": "2015-01-07T15:30:04.000Z",
        "updatedDate": "2015-01-07T15:31:27.000Z"
      },
      "InvoiceNumber__c": {
        "enum": [
          "dddd"
        ],
        "label": "Invoice Number",
        "type": "string",
        "description": "",
        "default": "dddd",
        "createdDate": "2019-10-04T21:10:01.000Z",
        "updatedDate": "2019-10-04T21:10:01.000Z"
      },
      "AccountStructure__c": {
        "enum": [
          "Public",
          "Private",
          "Wholly Owned Subsidiary",
          "VC Backed",
          "State and Local Govt",
          "Federal"
        ],
        "label": "Account Structure",
        "type": "string",
        "description": "Field used to support custom reporting and analysis.",
        "createdDate": "2015-01-09T22:33:11.000Z",
        "updatedDate": "2015-01-09T22:33:11.000Z"
      },
      "AccountProfile__c": {
        "enum": [
          "Small",
          "Medium",
          "Enterprise",
          "Strategic",
          "Growth"
        ],
        "label": "Account Profile",
        "type": "string",
        "description": "Custom field to support reporting by account type.",
        "default": "Small",
        "createdDate": "2015-01-09T22:30:56.000Z",
        "updatedDate": "2015-01-09T22:31:22.000Z"
      },
      "Entity__c": {
        "enum": [
          "North America",
          "EMEA",
          "APAC"
        ],
        "label": "Entity",
        "type": "string",
        "description": "",
        "default": "North America",
        "createdDate": "2014-12-26T17:13:00.000Z",
        "updatedDate": "2014-12-26T17:13:00.000Z"
      }
    },
    "indexed": [
      "AccountProfile__c",
      "AccountStructure__c",
      "Entity__c",
      "InvoiceNumber__c",
      "SEUseCase__c",
      "Territory__c"
    ],
    "additionalProperties": false
  }
}