GET residentapi/propertydocuments/{id}

Gets CommunityDocument by ID

Request Information

URI Parameters

Name	Description	Type	Additional information
id	(Required)	integer	Required

Body Parameters

None.

Response Information

Resource Description

Document

Name	Description	Type	Additional information
DocumentId	Document Id	integer	None.
PropertyId	Property Id. See the GET residentapi/properties/{propertyId} route to get the property data	integer	None.
TypeId	TypeId	integer	None.
SubTypeId	SubType	integer	None.
FileName	FileName	string	None.
Description	Description	string	None.
IsPrivate	IsPrivate	boolean	None.
DocumentName	DocumentName	string	None.
DateLabel	The title which describes what "DocumentDate" is	string	None.
DocumentDate	Document Date. Depends on Document Type	date	None.
CreatedOn	CreatedOn	date	None.
LastModifiedOn	LastModifiedDate	date	None.
IsFeatured	IsFeatured. Is the document a featured document	boolean	None.
PathToFile	Path To File. The residentapi/files?filePath={filePath} route must be called where the filePath parameter is the path to file value that is being returned by this resource	string	None.

Response Formats

application/json, text/json

Sample:

{
  "documentId": 1,
  "propertyId": 2,
  "typeId": 3,
  "subTypeId": 4,
  "fileName": "sample string 5",
  "description": "sample string 6",
  "isPrivate": true,
  "documentName": "sample string 8",
  "dateLabel": "sample string 9",
  "documentDate": "2025-12-24T09:11:30.1217694-05:00",
  "createdOn": "2025-12-24T09:11:30.1217694-05:00",
  "lastModifiedOn": "2025-12-24T09:11:30.1217694-05:00",
  "isFeatured": true,
  "pathToFile": "sample string 12"
}