GET residentapi/market/{c4uid}/connectresidents/{connectResidentId}

Returns CWS Unit object if connect resident is actively registered with the CWS.

Request Information

URI Parameters

Name	Description	Type	Additional information
c4uid		string	Required
connectResidentId		integer	Required

Body Parameters

None.

Response Information

Resource Description

MyUnit

Name	Description	Type	Additional information
MyUnitId	My Unit ID. Unique identifier of a unit.	integer	None.
PropertyId	Property ID.	integer	None.
UserId	User ID.	integer	None.
RoleId	Role ID.	integer	None.
Role	Role Object	CwsUserRole	None.
User	CwsUser Object	CwsUser	None.
MarketId	Market ID.	integer	None.
ConnectPropertyId	Connect Property ID.	integer	None.
ConnectUnitId	Connect Unit ID.	integer	None.
ConnectResidentId	Connect Resident ID.	integer	None.
IsLinked	Is Linked?	boolean	None.
IsDeleted	Is Deleted?	boolean	None.
IsActive	Is Active	boolean	None.
PropertyName	Property Name.	string	None.
SubDomain	SubDomain	string	None.
PropertyDisplayName	PropertyDisplayName. From the property configuration table (name displayed on the landing page)	string	None.
Addresses	Addresses. Addresses for the unit	Collection of CwsAddress	None.

Response Formats

application/json, text/json

Sample:

{
  "myUnitId": 1,
  "propertyId": 2,
  "userId": 3,
  "roleId": 4,
  "role": {
    "roleId": 1,
    "roleName": "sample string 2",
    "roleDescription": "sample string 3"
  },
  "user": {
    "userId": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "acceptedTermsAndConditions": true,
    "myUnits": [],
    "photos": [
      {
        "photoId": 1,
        "userId": 2,
        "fileUrl": "sample string 3",
        "isDefault": true
      },
      {
        "photoId": 1,
        "userId": 2,
        "fileUrl": "sample string 3",
        "isDefault": true
      }
    ],
    "userPhones": [
      {
        "phoneId": 1,
        "userId": 2,
        "phoneTypeId": 3,
        "phoneNumber": "sample string 4",
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "countryCode": "sample string 5",
        "isVerified": true
      },
      {
        "phoneId": 1,
        "userId": 2,
        "phoneTypeId": 3,
        "phoneNumber": "sample string 4",
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "countryCode": "sample string 5",
        "isVerified": true
      }
    ],
    "userEmails": [
      {
        "emailId": 1,
        "userId": 2,
        "emailTypeId": 3,
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "email": "sample string 4",
        "isVerified": true
      },
      {
        "emailId": 1,
        "userId": 2,
        "emailTypeId": 3,
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "email": "sample string 4",
        "isVerified": true
      }
    ],
    "committees": [
      {
        "userCommitteeId": 1,
        "committeeId": 2,
        "userId": 3,
        "startDate": "2025-12-24T09:17:28.8224025-05:00",
        "expirationDate": "2025-12-24T09:17:28.8224025-05:00",
        "propertyCommittee": {
          "property": {
            "propertyId": 1,
            "marketId": 2,
            "connectPropertyId": 3,
            "propertyName": "sample string 4"
          },
          "committeeID": 1,
          "propertyID": 2,
          "connectCommitteeID": 1,
          "name": "sample string 3",
          "description": "sample string 4",
          "isActive": true,
          "isDeleted": true,
          "isBoard": true
        }
      },
      {
        "userCommitteeId": 1,
        "committeeId": 2,
        "userId": 3,
        "startDate": "2025-12-24T09:17:28.8224025-05:00",
        "expirationDate": "2025-12-24T09:17:28.8224025-05:00",
        "propertyCommittee": {
          "property": {
            "propertyId": 1,
            "marketId": 2,
            "connectPropertyId": 3,
            "propertyName": "sample string 4"
          },
          "committeeID": 1,
          "propertyID": 2,
          "connectCommitteeID": 1,
          "name": "sample string 3",
          "description": "sample string 4",
          "isActive": true,
          "isDeleted": true,
          "isBoard": true
        }
      }
    ]
  },
  "marketId": 5,
  "connectPropertyId": 6,
  "connectUnitId": 7,
  "connectResidentId": 8,
  "isLinked": true,
  "isDeleted": true,
  "isActive": true,
  "propertyName": "sample string 12",
  "subDomain": "sample string 13",
  "propertyDisplayName": "sample string 14",
  "addresses": [
    {
      "addressId": 1,
      "myUnitId": 2,
      "addressTypeId": 3,
      "unitNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "zip": "sample string 9",
      "country": "sample string 10",
      "type": {
        "typeId": 1,
        "name": "sample string 2",
        "description": "sample string 3"
      }
    },
    {
      "addressId": 1,
      "myUnitId": 2,
      "addressTypeId": 3,
      "unitNumber": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "city": "sample string 7",
      "state": "sample string 8",
      "zip": "sample string 9",
      "country": "sample string 10",
      "type": {
        "typeId": 1,
        "name": "sample string 2",
        "description": "sample string 3"
      }
    }
  ]
}