GET api/BanyanProperty?authKey={authKey}&propertyName={propertyName}&deep={deep}

Request Information

URI Parameters

Name	Type	Additional information
authKey	string	Required
propertyName	string	Required
deep	boolean	Required

Body Parameters

None.

Response Information

Resource Description

BanyanProperty

Name	Type	Additional information
PropertyBillingMethodCollByPropertyId	Collection of Object	None.
ProviderAccountCollByPropertyId	Collection of Object	None.
UnitCollByPropertyId	Collection of Object	None.
StateCode	string	None.
PropertyId	globally unique identifier	None.
DateCreated	date	None.
DateUpdated	date	None.
ClientId	globally unique identifier	None.
Name	string	None.
Address1	string	None.
City	string	None.
StateId	globally unique identifier	None.
PostalCode	string	None.
CassId	integer	None.
CassSiteNumber	string	None.
UtCommunityId	integer	None.
UnitCount	integer	None.
TotalSquareFeet	decimal number	None.
ImageFileId	globally unique identifier	None.
AccountManagerUserId	globally unique identifier	None.
PropertyTypeId	globally unique identifier	None.
ConstellationName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "propertyBillingMethodCollByPropertyId": [],
  "providerAccountCollByPropertyId": [],
  "unitCollByPropertyId": [],
  "stateCode": null,
  "propertyId": "38847bd4-8aff-4521-8697-2227ead42932",
  "dateCreated": "2026-06-05T09:17:48.8342629+00:00",
  "dateUpdated": "2026-06-05T09:17:48.8342629+00:00",
  "clientId": "d05f023b-812c-4861-bd3b-8a9552d8a080",
  "name": "sample string 1",
  "address1": "sample string 2",
  "city": "sample string 3",
  "stateId": "c32f555b-7b8d-4fc3-ac48-8ebea14ce8c9",
  "postalCode": "sample string 4",
  "cassId": 1,
  "cassSiteNumber": "sample string 5",
  "utCommunityId": 1,
  "unitCount": 1,
  "totalSquareFeet": 1.1,
  "imageFileId": "13cf5a02-c754-40b5-9825-686d7348b346",
  "accountManagerUserId": "b8b74bf5-c67d-4c99-a9b1-33bb9c6c39e1",
  "propertyTypeId": "26e652c2-d138-4bbb-9f15-1cda95f12c43",
  "constellationName": "sample string 6",
  "modifiedColumns": [
    "account_manager_user_id",
    "client_id",
    "image_file_id",
    "property_type_id",
    "state_id",
    "property_id",
    "date_created",
    "date_updated",
    "name",
    "address1",
    "city",
    "postal_code",
    "cass_id",
    "cass_site_number",
    "ut_community_id",
    "unit_count",
    "total_square_feet",
    "constellation_name"
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: No set method for property 'StateCode' in type 'BusinessObjects.BanyanProperty'.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: No set method for property 'StateCode' in type 'BusinessObjects.BanyanProperty'.