API v1 Reference

List Members

This request is used to search for members, and to retrieve information about them. Use this to formulate a search request by defining the search terms and the output columns. Results are paginated, but the page size can be defined in your request. Also, a combination of search parameters uses AND logic. You cannot search [parameter 1 = this] OR [parameter 2 = this] using this request.

This sample request searches for any Memberships that match the specified User last name. It returns the columns AccountId, User Full Name, Salutation, User Type, Membership Name, Membership Cost and Membership Start Date.

REST

Request

https://api.neoncrm.com/neonws/services/api/membership/listMemberships?responseType=xml&userSessionId=T1361771201400&outputfields.idnamepair.name=Account%20ID&outputfields.idnamepair.name=User%20Full%20Name%20(F)&outputfields.idnamepair.name=Salutation&outputfields.idnamepair.name=User%20Type&outputfields.idnamepair.name=Membership%20Name&outputfields.idnamepair.name=Membership%20Cost&outputfields.idnamepair.name=Membership%20Start%20Date&searches.search.key=Last%20Name&searches.search.searchOperator=EQUAL&searches.search.value=[User Last Name]

Response

{
    "listMembershipsResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2013-02-25T00:42:13.494-06:00",
        "page": {
            "currentPage": 1,
            "pageSize": 10,
            "totalPage": 2,
            "totalResults": 13
        },
        "searchResults": {
            "nameValuePairs": [
                {
                    "nameValuePair": [
                        {
                            "name": "Account Id",
                            "value": 123942
                        },
                        {
                            "name": "User Type",
                            "value": "Individual"
                        },
                        {
                            "name": "Salutation"
                        },
                        {
                            "name": "Membership Name",
                            "value": "Gold Level Membership"
                        },
                        {
                            "name": "Membership Start Date",
                            "value": "2012-09-01"
                        },
                        {
                            "name": "Membership Cost",
                            "value": 50
                        },
                        {
                            "name": "User Full Name (F)",
                            "value": "Jason Example"
                        }
                    ]
                }
            ]
        }
    },
    ...
}

Valid Fields

Search Criteria

Output Columns