Get Relationships for a Contact

GET

/api/Relationship/ByContact/:contactId

GET

/api/Relationship/ByContact/:contactId

curl -G https://api.virtuoussoftware.com/api/Relationship/ByContact/contactId \
     -H "Authorization: Bearer <token>" \
     -d skip=1 \
     -d take=1

200Contacts and Individuals_getRelationshipsForAContact_example

{
  "list": [
    {
      "id": "<integer>",
      "contactId": "<integer>",
      "contact": "<string>",
      "contactIndividual": "<string>",
      "relatedContactId": "<integer>",
      "relatedContact": "<string>",
      "relatedContactIndividual": "<string>",
      "relationshipType": "<string>",
      "notes": "<string>",
      "relatedContactViewUrl": "<string>"
    },
    {
      "id": "<integer>",
      "contactId": "<integer>",
      "contact": "<string>",
      "contactIndividual": "<string>",
      "relatedContactId": "<integer>",
      "relatedContact": "<string>",
      "relatedContactIndividual": "<string>",
      "relationshipType": "<string>",
      "notes": "<string>",
      "relatedContactViewUrl": "<string>"
    }
  ],
  "total": "<integer>"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

contactIdstringRequired

Query parameters

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10.

Response

listlist of objectsOptional

totalstringOptional