List Custom Object Fields

Lists all fields for a specific custom object.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObject/listCustomObjectFields

Request

https://api.neoncrm.com/neonws/services/api/customObject/listCustomObjectFields?userSessionId=[session id]&objectApiName=Museum_Visits_c

Response

{
  "listCustomObjectFieldsResponse": {
    "operationResult": "SUCCESS",
    "responseDateTime": "2017-05-19T17:31:16.826+0000",
    "customObjectFields": {
      "customObjectField": [
        {
          "fieldId": 229,
          "fieldLabel": "Visit ID",
          "fieldApiName": "name",
          "fieldDataType": "AUTO_NUMBER"
        },
        {
          "fieldId": 231,
          "fieldLabel": "Create By",
          "fieldApiName": "createBy",
          "fieldDataType": "TEXT"
        },
        {
          "fieldId": 232,
          "fieldLabel": "Create Time",
          "fieldApiName": "createTime",
          "fieldDataType": "DATETIME"
        },
        {
          "fieldId": 233,
          "fieldLabel": "Last Modified By",
          "fieldApiName": "lastModifyBy",
          "fieldDataType": "TEXT"
        },
        {
          "fieldId": 234,
          "fieldLabel": "Last Modified Time",
          "fieldApiName": "lastModifyTime",
          "fieldDataType": "DATETIME"
        },
        {
          "fieldId": 237,
          "fieldLabel": "Account ID",
          "fieldApiName": "Account_ID_c",
          "fieldDescription": "The linked NeonCRM Account for this record.",
          "fieldDataType": "MASTER_DETAIL"
        },
		{
          "fieldId": 238,
          "fieldLabel": "Visit Date",
          "fieldApiName": "Visit_Date_c",
          "fieldDescription": "The date of a museum visit.",
          "fieldDataType": "DATE"
        },
		{
          "fieldId": 239,
          "fieldLabel": "Group Size",
          "fieldApiName": "Group_Size_c",
          "fieldDescription": "The number of people in the group who visited.",
          "fieldDataType": "NUMBER"
        }
      ]
    },
    "page": {
      "currentPage": 1,
      "pageSize": 10,
      "totalPage": 1,
      "totalResults": 6
    }
  }
}

Request Parameters

Parameter Required Description
objectApiName Required This is the token used to identify the Custom Object when accessing it from the API.

Response Parameters

Parameter Description
customObjectFields.customObjectField.fieldId The internal ID for this field.
customObjectFields.customObjectField.fieldLabel This is the unique name used to identify the field in the custom object. It will also be used in the data entry and data list pages.
customObjectFields.customObjectField.fieldApiName The name used to identify this field for referencing via the API.
customObjectFields.customObjectField.fieldDataType Possible values: AUTO_NUMBER, TEXT, FORMULA, NUMBER, EMAIL, PHONE, URL, PERCENT, TEXTAREA_SHORT, TEXTAREA, DATE, DATETIME, CHECKBOX_SINGLE, CHECKBOX, DROPDOWN, RADIO, MASTER_DETAIL, LOOKUP
page.currentPage
page.pageSize
page.totalPage
page.totalResults

Error Codes

Code Text Description
20001 Object API name is required.
20002 Object API name is invalid.