GET v1/units/{id}/mailingaddress?apiKey={apiKey}

Returns the mailing address of a unit

Request Information

URI Parameters

Name	Description	Type	Additional information
id	UnitID of the unit	integer	Required
apiKey		string	Required

Body Parameters

None.

Response Information

Resource Description

Address

Name	Type	Additional information
AddressID	integer	None.
Street1	string	None.
Street2	string	None.
City	string	None.
State	string	None.
Zip	string	None.
IsInternational	boolean	None.
CountryId	integer	None.
CreateDate	date	None.
CreateBy	string	None.
ModifyDate	date	None.
ModifyBy	string	None.
AddressCoName	string	None.
Country	Country	None.

Response Formats

application/json, text/json

Sample:

{
  "addressID": 1,
  "street1": "sample string 2",
  "street2": "sample string 3",
  "city": "sample string 4",
  "state": "sample string 5",
  "zip": "sample string 6",
  "isInternational": true,
  "countryId": 1,
  "createDate": "2025-12-05T22:20:15.2138448-05:00",
  "createBy": "sample string 8",
  "modifyDate": "2025-12-05T22:20:15.2138448-05:00",
  "modifyBy": "sample string 9",
  "addressCoName": "sample string 10",
  "country": {
    "countryId": 1,
    "countryName": "sample string 2",
    "countryCode": "sample string 3",
    "addresses": []
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.