GET residentapi/directory/{id}

Gets UserDirectory by id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	(Required)	integer	Required

Body Parameters

None.

Response Information

Resource Description

UserDirectory

Name	Description	Type	Additional information
DirectoryId	DirectoryId (Primary key)	integer	None.
MyUnitId	MyUnitId (Foreign Key to MyUnits)	integer	None.
PhoneId	PhoneId (Nullable Foregin Key to UserPhone)	integer	None.
ShowAddress	ShowAddress	boolean	None.
ShowPhoneNumber	ShowPhoneNumber	boolean	None.
ShowEmail	ShowEmail	boolean	None.
MyUnit	MyUnit	MyUnit	None.

Response Formats

application/json, text/json

Sample:

{
  "directoryId": 1,
  "myUnitId": 2,
  "phoneId": 1,
  "showAddress": true,
  "showPhoneNumber": true,
  "showEmail": true,
  "myUnit": {
    "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:11:29.62083-05:00",
          "expirationDate": "2025-12-24T09:11:29.62083-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:11:29.62083-05:00",
          "expirationDate": "2025-12-24T09:11:29.62083-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"
        }
      }
    ]
  }
}