Page tree



Returns the complete details of a connection.


Required Permissions

The user must fall into one of the categories below:

  • System Administration

  • A user with the following rights:

    • Ability to assign contacts

    • View rights to at least one Connection Type

Request Header

Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.

username: "jadams"

password: "password231"

URL Parameters

site_number – The site number to gather data for.

connection_type_id – The connection id for the type of connection you are selecting. Values from Connection Type API.


Query String Parameters

include_self  To include yourself in the Team Member List when set to True. The default value is False.

Return Data

  "FamId": 1492,
  "FamilyConnection": true,
  "DateCreated": "3/29/2004",
  "OpenField": null,
  "PermissionLevel": "All",
  "Responses": [],
  "ConnectionId": 1071,
  "ConnectionTypeId": 6,
  "ConnectionTypeDescription": "Outreach Team Contact",
  "ContactType": "Outward",
  "DueDate": "4/5/2004",
  "Comment": null,
  "DueDateLong": "Monday, April 05, 2004",
  "Completed": false,
  "TeamMemberCount": 0,
  "ContactInformation": {
    "Country": "USA",
    "Company": null,
    "Address": "111 Home Ave",
    "Address2": null,
    "City": "Florence",
    "State": "SC",
    "Zipcode": "29501",
    "CityStateZip": "Florence, SC 29501",
    "Email": null,
    "EmailListed": true,
    "PhoneNumber": "111-111-1111",
    "PhoneListed": true,
    "IndvId": 945,
    "FamId": 1492,
    "FamilyPosition": "Head",
    "Title": "Mr.",
    "FirstName": "Jonathan",
    "LastName": "Doe",
    "MiddleName": null,
    "GoesByName": "Jon",
    "Suffix": null,
    "PictureUrl": ""
  "TeamMembers": []