Back to Developer Center

API v1 Reference

List Relation Types

Use this request to retrieve a list of relation types in your NeonCRM.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/listRelationTypes?userSessionId=[sessionId]&relationTypeCategory=Individual-Individual

Response

{ "listRelationTypesResponse": { 
    "operationResult": "SUCCESS", 
    "responseMessage": "1 records was found.", 
    "responseDateTime": "2012-12-27T01:57:15.857-06:00", 
    "relationTypes": { 
        "relationType": [ 
            {
				"id": "1",
				"name": "Spouse"
			}
		]	
        
	}

Request Parameters

Name Required Description
relationTypeCategory Yes * Relation Category Name is required. Individual-Individual is the only supported Relation Type at this time.

Response Parameters

Name Required Description
relationType.id Yes ID of the Relation Type
relationType.name Yes Name of the Relation Type

Error Codes

Code Text Description
10150 Relation Type is required.