List Accounts by Keyword Search

This is an account search that is similar to the search box in the upper-right corner of NeonCRM. It searches for accounts by Name, Email, or Account ID. You must include the search term as the Keyword parameter, and you must specify whether you are searching individual or organization accounts.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/listAccountsByKeywordSearch?userSessionId=[session id]&userType=Individual&keyword=joe

Response

{
    "listAccountsByKeywordSearchResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2014-04-10T17:58:07.666+08:00",
        "accountSearchResults": {
            "accountSearchResult": [
                {
                    "accountId": 99748,
                    "firstName": "Hudson, Joe (Leon)",
                    "userType": "Individual"
                },
                {
                    "accountId": 99752,
                    "firstName": "Hyde, Joe",
                    "userType": "Individual"
                },
                {
                    "accountId": 115659,
                    "firstName": "Joe",
                    "lastName": "",
                    "userType": "Individual"
                },
                {
                    "accountId": 115693,
                    "firstName": "Joey",
                    "lastName": "",
                    "userType": "Individual"
                },
                {
                    "accountId": 98406,
                    "firstName": "Joe",
                    "lastName": "Armstrong",
                    "email": "support@z2systems.com.z2",
                    "userType": "Individual"
                },
                {
                    "accountId": 101432,
                    "firstName": "Joe",
                    "lastName": "Average",
                    "organizationName": "The Example Foundation",
                    "email": "joe@example.org.z2",
                    "userType": "Individual"
                },
                {
                    "accountId": 97814,
                    "firstName": "Joe",
                    "lastName": "B",
                    "email": "",
                    "userType": "Individual"
                }
            ]
        },
        "page": {
            "currentPage": 1,
            "pageSize": 10,
            "totalPage": 8,
            "totalResults": 73
        }
    }
}

Request Parameters

Name Required Description
keyword Yes Search keyword, which could include First Name, Last Name, Email, Account Id.
userType Yes Possible values: Individual, Organization
page.currentPage Request a specific page of results.
page.pageSize Specify the number of results in this page.
page.sortColumn Sort results by the specified column (see response parameters for options).
page.sortDirection Possible values: ASC, DESC.

Response Parameters

Name Required Description
accountSearchResult.userType Yes Individual or Organization
accountSearchResult.accountId Yes
accountSearchResult.firstName
accountSearchResult.lastName
accountSearchResult.organizationName
accountSearchResult.email
page.currentPage
page.pageSize
page.totalPage
page.totalResults
page.sortColumn
page.sortDirection

Error Codes

Code Text Description
10231 User type is invalid. User type must be Individual or Organization.
10232 User type is required. You must supply a user type in your request.
10250 Keyword is required. Your request must include a keyword. This could be account ID, first name, last name, or email.