Find the list of relation for a contact
The API provides the feature to get the list of relationships for a contact. In order to get the list pass the contacts id as reference id, the API returns all the relationship with a flag of relationship type, in order to get the specific type of relationship refer APIs to provide specific type of relationships like Children, Spouse.
Request Information
URI Parameters
In order to make a call integrate the below parameters into Url while calling the API from an integration.
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId |
Contact Id |
integer |
Required |
Get the list of relationship for a contact
Below is the example to get the list of relationship for a contact:
admin/contact/relationships/9831292
Response Information
Resource Description
List of Relationships
ITypedResponseOfListOfRelationship2| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | Collection of Relationship2 |
None. |
|
| Category | string |
None. |
Response Formats
Sample not available.