Back to Developer Center

API v1 Reference

List Custom Object Records

Retrieves records for an existing custom object.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObjectRecord/listCustomObjectRecords

Request

https://api.neoncrm.com/neonws/services/api/customObjectRecord/listCustomObjectRecords?userSessionId=abcde12345&objectApiName=Update_Emails_c&customObjectOutputFieldList.customObjectOutputField.label=Update%20Emails%20Name&customObjectOutputFieldList.customObjectOutputField.label=Email&customObjectOutputFieldList.customObjectOutputField.label=Account&customObjectOutputFieldList.customObjectOutputField.columnName=name&customObjectOutputFieldList.customObjectOutputField.columnName=Email_c&customObjectOutputFieldList.customObjectOutputField.columnName=Account_c&customObjectSearchCriteriaList.customObjectSearchCriteria.criteriaField=Account_c&customObjectSearchCriteriaList.customObjectSearchCriteria.operator=EQUAL&customObjectSearchCriteriaList.customObjectSearchCriteria.value=101177

Response

{
    "listCustomObjectRecordsResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2018-02-12T15:34:07.922+0000",
        "page": {
            "currentPage": 1,
            "pageSize": 20,
            "totalPage": 1,
            "totalResults": 1
        },
        "searchResults": {
            "nameValuePairs": [
                {
                    "nameValuePair": [
                        {
                            "name": "id",
                            "value": "1"
                        },
                        {
                            "name": "name",
                            "value": "#1"
                        },
                        {
                            "name": "Email_c",
                            "value": "test@test.net"
                        },
                        {
                            "name": "Account_c.id",
                            "value": "101177"
                        },
                        {
                            "name": "Account_c",
                            "value": "Ambrose Burnside"
                        }
                    ]
                }
            ]
        }
    }
}

Request Parameters

Parameter Required Description
userSessionId Yes
objectApiName Yes
The following two parameters must be included for each field you want to include in the response. You may repeat this pair of parameters as many times as you like.
customObjectOutputFieldList.customObjectOutputField.label Yes The Field Label for a field to be included in the response.
customObjectOutputFieldList.customObjectOutputField.columnName Yes The API Name for a field to be included in the response.
The following parameters are used to add search criteria to this request. You must include all three parameters for each search criterion. You may repeat these groups of parameters as many times as you like.
customObjectSearchCriteriaList.customObjectSearchCriteria.criteriaField The API Name for a field to be used as a search criterion.
customObjectSearchCriteriaList.customObjectSearchCriteria.operator Possible values are variable, depending on the data type of the field being searched. Values are listed in the section below.
customObjectSearchCriteriaList.customObjectSearchCriteria.value The data value to be searched for this field. This parameter must be included when searching fields of these data types: AUTO_NUMBER, URL, TEXT, EMAIL, PHONE, TEXTAREA, TEXTAREA_SHORT, NUMBER, PERCENT, DATE, DATETIME, RADIO, PICKLIST, LOOKUP, CHECKBOX_SINGLE
customObjectSearchCriteriaList.customObjectSearchCriteria.valueList.idNamePair.name The data values to be searched. This parameter must be included when searching fields of these data types: CHECKBOX
page.pageSize Number of results to include per page. Possible values: integers between 0 and 200.
page.currentPage Request a specific page of results.
page.sortColumn The API Name of a column to use for sorting results.
page.sortDirection Possible values: ASC, DESC

Search Operators

The following search operators are available for these data types:

Data Type Operators
AUTO_NUMBER EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, CONTAIN
URL EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, CONTAIN,
TEXT EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, CONTAIN
EMAIL EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, CONTAIN
PHONE EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, CONTAIN
TEXTAREA BLANK, NOT_BLANK, CONTAIN
TEXTAREA_RICH BLANK, NOT_BLANK, CONTAIN
TEXTAREA_SHORT BLANK, NOT_BLANK, CONTAIN
NUMBER EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, LESS_THAN, GREATER_THAN, LESS_AND_EQUAL, GREATER_AND_EQUAL
PERCENT EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, LESS_THAN, GREATER_THAN, LESS_AND_EQUAL, GREATER_AND_EQUAL
DATE EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, LESS_THAN, GREATER_THAN, LESS_AND_EQUAL, GREATER_AND_EQUAL
DATETIME EQUAL, NOT_EQUAL, BLANK, NOT_BLANK, LESS_THAN, GREATER_THAN, LESS_AND_EQUAL, GREATER_AND_EQUAL
RADIO EQUAL, NOT_EQUAL, BLANK, NOT_BLANK
PICKLIST EQUAL, NOT_EQUAL, BLANK, NOT_BLANK
LOOKUP EQUAL, NOT_EQUAL, BLANK, NOT_BLANK
CHECKBOX IN_RANGE, BLANK, NOT_BLANK
CHECKBOX_SINGLE(BOOL) EQUAL

Response Parameters

Parameter Required Description
searchResults.nameValuePairs.name
searchResults.nameValuePairs.value

Error Codes

Code Text Description
20001 Object API name is required.
20002 Object API name is invalid.
20081 Custom object search criteria field API name is required.
20082 Custom object search criteria field API name is invalid.
20083 Custom object search criteria operator is required.
20084 Custom object search criteria operator is invalid.
20085 Custom object search criteria value is invalid.
20086 Custom object output field API name is required.
20087 Custom object output field API name is invalid.
20088 Custom object search criteria value list is invalid.
20089 Custom object search criteria checkbox single value could be yes or no. What a cryptic message! You might wonder if the API is experiencing an existential crisis. Fear not. All you need to do is supply a value of “yes” or “no” to the API to resolve this problem.