Follow

Querying Relationships

Relationships List

GET https://app.connectworks.com/restapi/v1/relationships/

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.
Filter No

Filter parameters:

keywords (list of keywords to match against organisation name or matter/client number) 

Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/relationships/"

Example Response:

[{
"id": 6269,
"version": 13,
"name": "Bob Smith",
"organisationId": 1519,
"organisationName": "Bob\u0027s Firm",
"organisationType": "PARTNER",
"type": "PERSON",
"userId": 204,
"userRelationship": true,
"userAvatarType": "NONE",
"related": false,
"person": true,
"_type": "RelationshipReferenceResult"
},
{
"id": 7057,
"version": 2,
"name": "Bob\u0027s Trust 1",
"organisationId": 1700,
"organisationName": "Wounded Bull Limited",
"organisationType": "COMPANY",
"type": "RELATED",
"relatedId": 1520,
"userRelationship": false,
"relatedName": "Bob\u0027s Trust 1",
"related": true,
"person": false,
"_type": "RelationshipReferenceResult"
}]

Relationships List for an Organisation

GET https://app.connectworks.com/restapi/v1/relationships/organisation-{organisation_id}

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.
Filter No

Filter parameters:

keywords (list of keywords to match against organisation name or matter/client number) 

 Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/v1/relationships/organisation-1023"

Example Response:

[{
"id": 6269,
"version": 13,
"name": "Bob Smith",
"organisationId": 1519,
"organisationName": "Bob\u0027s Firm",
"organisationType": "PARTNER",
"type": "PERSON",
"userId": 204,
"userRelationship": true,
"userAvatarType": "NONE",
"related": false,
"person": true,
"_type": "RelationshipReferenceResult"
},
{
"id": 7057,
"version": 2,
"name": "Bob\u0027s Trust 1",
"organisationId": 1700,
"organisationName": "Wounded Bull Limited",
"organisationType": "COMPANY",
"type": "RELATED",
"relatedId": 1520,
"userRelationship": false,
"relatedName": "Bob\u0027s Trust 1",
"related": true,
"person": false,
"_type": "RelationshipReferenceResult"
}]

Signatories for an Organisation

GET https://app.connectworks.com/restapi/v1/relationships/organisation-{organisationId}/signatories

Parameter Required Comment
Limit No Number of records to retrieve.  Must be less than or equal to 100.
Offset No Starting record for results to return.  Zero-based index.
Order No Sorting order of the results.

 Example Request:

curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 1886f011cd72eabc88d087eabd741b51a9059f5ba57c7bc439285fe86a4e465a" https://app.connectworks.com/restapi/relationships/organisation-1023/signatories"

Example Response:

[{
"id":4150,
"name":"Bob Smith",
"organisationId":1023,
"organisationName":"Bob Smith Trustees Limited",
"organisationType":"COMPANY",
"type":"PERSON",
"relatedId":null,
"userId":null,
"userRelationship":false,
"userAvatarType":null,
"relatedName":null,
"relatedType":null,
"searchHints":null,
"canUserNavigate":false,
"secretary":false,
"chairman":false,
"treasurer":false,
"advisor":false,
"govenor":true,
"employee":false,
"beneficiary":false,
"settlor":false,
"protector":false,
"executor":false,
"appointer":false,
"beneficiaryType":"OTHER",
"subscriptionPlan":{"id":1,"version":0,"forceRevision":false,"canUserDelete":false,"canUserDisable":false,"canUserModify":false,"name":"Guest","model":"GUEST","_type":"SubscriptionPlanReferenceResult"},"related":false,"person":true,"_type":"RelationshipInfoResult"}]

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk