List of Trust Relationships
GET {{baseUrl}}/cas/trusts/:trustId/relationships?offset=0&limit=500&includeHistory
A list of relationships for a Trust. By default the call only current relationships will be returned.
Parameter - includeHistory
will include both current and historical relationships linked to the trust.
Response Body
| Key | Date Type | Description |
|---|---|---|
| contactId | String | the contact id of the contact that has the relationship List of Contacts |
| companyId | String | the company id of the company that has the relationship |
| appointDate | Date | The appointment date of the relationship |
| ceasedDate | Date | The ceased date of the relationship. Only where includeHistory=true |
| relationshipType | String | This is the relationship type of the contact. Will be one of SETTLOR, APPOINTOR, TRUSTEE, ACCOUNTANT, AUDITOR, BANK, BUSINESSNAME, INVESTMENTADVISOR, LAWYER, LIQUIDATOR |
| prepareForm | boolean |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | number | ||
limit | number | ||
includeHistory | null | include current and historical relationships linked to the trust. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"trustRelationships":[{"id":675963,"contactId":"null","companyId":"abcd-efg-hijk-lmnop","appointDate":"2020-03-18","relationshipType":"TRUSTEE","prepareForm":false},{"id":675960,"contactId":569106,"appointDate":"2020-03-18","relationshipType":"APPOINTOR","prepareForm":false},{"id":450332,"contactId":667336,"appointDate":"2019-12-09","relationshipType":"SETTLOR","prepareForm":false},{"id":675964,"contactId":567874,"companyId":"null","appointDate":"2020-03-18","relationshipType":"TRUSTEE","prepareForm":false}],"offset":1,"limit":500,"total":4}