How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Propertyware Documents API

Resources providing access to documents.

Propertyware Documents API is one of 14 APIs that Propertyware publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.propertyware.com/pw/api/rest/v1.

6 operations 3 paths 5 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.propertyware.com/pw/api/
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Propertyware Documents API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-propertyware-client-id (clientId). An API key is passed in the header as x-propertyware-client-secret (clientSecret). An API key is passed in the header as x-propertyware-system-id (organizationId). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 6

Resources providing access to documents.

GET
/docs
Retrieve all documents
retrieveAllDocuments 7 params → 200400401403
POST
/docs
Upload a document
uploadDocument 4 params body → 201400401403
GET
/docs/{documentId}
Retrieve a document
retrieveDocument 1 param → 200400401403404
PUT
/docs/{documentId}
Update a document
updateDocument 1 param body → 200400401403404
DELETE
/docs/{documentId}
Delete a document (BETA)
deleteDocument 1 param → 200204400401403404
GET
/docs/{documentId}/download
Download a document
downloadDocument 1 param → 200400401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Document (12 properties), UpdateDocument (4 properties), ErrorResponse (3 properties), ResponseEntity (2 properties). Each schema is shown below with its type and property counts.

RESTAPIError
object
2 properties
Document
object
12 properties
ErrorResponse
object
3 properties
ResponseEntity
object
2 properties
UpdateDocument
object
Update Document
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

propertyware-documents-api-openapi.yml Raw ↑

Other APIs Propertyware publishes across the network.

Propertyware Accounting API
Propertyware Bills API
Propertyware Buildings API
Propertyware Contacts API
Propertyware Custom field definitions API
Propertyware Health check API
Propertyware Inspections API
Propertyware Leases API
Propertyware Portfolios API
Propertyware Prospects API
Propertyware Units API
Propertyware Vendors API
Where this information came from

This is an independent, third-party profile of Propertyware Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.