GET api/documents/{Id}

Get document data by the Id. To retrieve the actual file, the api/files?filePath={filePath} route must be called where the filePath parameter is the PathToFile value that is being returned by this resource.

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
Id

(Required)

 integer

Required

Body Parameters

None.

Response Information

Resource Description

CommunityDocument
NameDescriptionTypeAdditional information
DocumentId

Document Id. Primary key of the documents table.

 integer

None.
PropertyId

Property Id. See the GET api/properties/{propertyId} route to get the property data.

 integer

None.
DocumentTypeId

Document Type Id. See the GET api/documenttypes/{Id} route to get the document type data.

 integer

None.
DocumentAttachmentTypeId

Document Attachment Type Id. See the GET api/documenttypes/{docTypeId}/subtypes route to get the document attachment type data.

 integer

None.
DocumentPrivateFlag

Document Private Flag. A value of one indicates that the flag is set to private. A value of zero indicates that the flag is set to public.

 integer

None.
DocumentDate

Document Date.

 date

None.
DocumentName

Document Name.

 string

None.
DocumentNotes

Document Notes.

 string

None.
PathToFile

The path to the actual location of the file.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "DocumentId": 1,
  "PropertyId": 2,
  "DocumentTypeId": 3,
  "DocumentAttachmentTypeId": 1,
  "DocumentPrivateFlag": 4,
  "DocumentDate": "2026-02-21T00:37:54.7307545-05:00",
  "DocumentName": "sample string 5",
  "DocumentNotes": "sample string 6",
  "PathToFile": "sample string 7"
}