List of Trusts by Label ID
GET {{baseUrl}}/cas/labels/{{labelId}}/trusts?offset={{offset}}&limit={{limit}}
Returns a list of all non-deleted trusts which the user has access to and which are attached to the label in the query.
Query Parameters
Form Parameter | type | Mandatory | Description |
---|
offset | number | Required | Example = 0 |
limit | number | Required | Example = 500 |
Response Body
Key | Datatype | Mandatory | Constraints |
---|
ABN | String | No | Must be a valid ACN if jurisdiction is 'Australia' |
formedDate | String | Yes | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
id | String | Yes | Trust Id |
trustNameId | String | Yes | existing Contact Id |
trusteeAppointedDate | String | No | ISO 8601 date https://en.wikipedia.org/wiki/ISO_8601 |
trusteeCompanyId | String | Yes | existing Company Id |
trusteeContactId | String | Yes | existing Contact Id |
type | Object | Yes | Must be either 'UNIT' or 'DISCRETIONARY' |
appointorId | String | No | existing Contact Id |
settlorId | String | No | existing Contact Id |
Request Params
Key | Datatype | Required | Description |
---|
offset | string | | number |
limit | string | | number |
Key | Datatype | Required | Description |
---|
Authorization | string | | |
RESPONSES
status: OK
{"trusts":[{"id":17337,"trustNameId":568906,"type":"UNIT","abn":null,"trusteeCompanyId":"022154b9-ce7c-4814-9c8b-11b7d0c1f076","trusteeContactId":null,"appointorId":null,"settlorId":null,"formedDate":"1890-01-15","trusteeAppointedDate":"2015-05-26"},{"id":17788,"trustNameId":572578,"type":"UNIT","abn":null,"trusteeCompanyId":"4800af6e-14b8-4b79-9326-30faeb32ad51","trusteeContactId":null,"appointorId":null,"settlorId":null,"formedDate":"2019-02-25","trusteeAppointedDate":"2019-02-25"}],"offset":0,"limit":500,"total":2}