List Custom Fields

Custom fields, also known as Attributes, are created by users from within NeonCRM. They differ from Standard System Fields because they can be configured by users. This request can be used to display information about all existing custom fields of a particular type, as well as all possible values for a given custom field.

Caution!

If you are developing an API-based application using a sandbox NeonCRM system, be aware that the IDs for Custom Fields will be different from your production system. We recommend abstracting these IDs from your requests in order to make your code more portable when moving from sandbox to production.

REST

Request

https://api.neoncrm.com/neonws/services/api/common/listCustomFields?userSessionId=[session id]&searchCriteria.component=Account

Response

{ 
    "listCustomFieldsResponse": { 
        "operationResult": "SUCCESS", 
        "responseMessage": "2 records was found.", 
        "responseDateTime": "2012-12-26T00:37:33.009-06:00", 
        "customFields": { 
            "customField": [ 
                { 
                "fieldId": 635, 
                "fieldName": "Artist Name", 
                "dataType": "Radio", 
                "component": "Account", 
                "fieldOptions": { 
                    "fieldOption": [ 
                        {
                        "id": 2374, 
                        "name": "artist 1" 
                        },
                        { 
                        "id": 2376, 
                        "name": "artist 2" 
                        },
                        {
                        "id": 2375, 
                        "name": "artist 3" 
                        }, 
                        { 
                        "id": 2377, 
                        "name": "artist 4" 
                        } 
                    ] 
                } 
                },
                { 
                "fieldId": 664, 
                "fieldName": "Maiden Name", 
                "dataType": "OneLineText", 
                "component": "Account" 
                }
                ] 
            }
        }
    }

SOAP

Request

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
   <soapenv:header>
       <soapenv:body>
          <neon:listcustomfieldsrequest>
             <usersessionid>T1357624094982</usersessionid>
             <searchcriteria>
                <search>
                   <id></id>
                   <name>Favorite Color</name>
                </search>
                <component>Account</component>
             </searchcriteria>
          </neon:listcustomfieldsrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listcustomfieldsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>3 records were found.</responsemessage>
         <responsedatetime>2013-01-07T23:51:53.528-06:00</responsedatetime>
         <customfields>
            <customfield>
               <fieldid>53</fieldid>
               <fieldname>Alignment Score</fieldname>
               <datatype>Dropdown</datatype>
               <component>Account</component>
               <fieldoptions>
                  <fieldoption>
                     <id>16</id>
                     <name>1</name>
                  </fieldoption>
                  <fieldoption>
                     <id>17</id>
                     <name>2</name>
                  </fieldoption>
                  <fieldoption>
                     <id>18</id>
                     <name>3</name>
                  </fieldoption>
               </fieldoptions>
            </customfield>
            <customfield>
               <fieldid>52</fieldid>
               <fieldname>Capacity Score</fieldname>
               <datatype>Dropdown</datatype>
               <component>Account</component>
               <fieldoptions>
                  <fieldoption>
                     <id>19</id>
                     <name>0</name>
                  </fieldoption>
                  <fieldoption>
                     <id>13</id>
                     <name>1</name>
                  </fieldoption>
                  <fieldoption>
                     <id>14</id>
                     <name>2</name>
                  </fieldoption>
                  <fieldoption>
                     <id>15</id>
                     <name>3</name>
                  </fieldoption>
               </fieldoptions>
            </customfield>
            <customfield>
               <fieldid>51</fieldid>
               <fieldname>Relationship Score</fieldname>
               <datatype>Dropdown</datatype>
               <component>Account</component>
               <fieldoptions>
                  <fieldoption>
                     <id>10</id>
                     <name>1</name>
                  </fieldoption>
                  <fieldoption>
                     <id>11</id>
                     <name>2</name>
                  </fieldoption>
                  <fieldoption>
                     <id>12</id>
                     <name>3</name>
                  </fieldoption>
               </fieldoptions>
            </customfield>
         </customfields>
      </ns2:listcustomfieldsresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
searchCriteria.component Yes Possible values: Account, Donation, Event, Attendee, Individual, Organization, Activity, Membership, Product
searchCriteria.search.id Retrieve a specific field by searching its ID.
searchCriteria.search.name Retrieve a specific field by searching its name.

Response Parameters

Name Required Description
customField.fieldId Yes The custom field’s ID
customField.fieldName Display name for the custom field
customField.code
customField.dataType Data format type for a custom field. Possible values: Checkbox, Dropdown, OneLineText, MultiLineText, Password, File, Radio, Account
customField.component Yes Possible values: Account, Donation, Event, Attendee, Individual, Organization, Activity, Membership, Product
customField.fieldOptions.fieldOption.id ID for an option for a specific custom field.
customField.fieldOptions.fieldOption.name Display name for an option for a specific custom field.