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 Prospects API

Resources providing access to prospects.

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

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

This API exposes 11 operations across 8 paths, and defines 19 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.

11 operations 8 paths 19 schemas 1 DELETE6 GET3 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 Prospects 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 11

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

Prospects 11

Resources providing access to prospects.

GET
/prospects
Retrieve all prospects
getProspects 10 params → 200400401403
POST
/prospects
Create a prospect
createProspect body → 201400401403404
POST
/prospects/bulk
Create prospects in bulk
createContactsUsingPOST_2 body → 201400401403
PUT
/prospects/customfields
Update a prospect custom fields (BETA)
updateLeaseUsingPUT_2 body → 200400401403404
GET
/prospects/statuses
Retrieve all prospect statuses
getProspectStatuses → 200400401403404
GET
/prospects/{prospectID}
Retrieve a prospect
getProspect 2 params → 200400401403404
GET
/prospects/{prospectID}/campaign
Retrieve prospect campaign
getProspectCampaign 1 param → 200204400401403404
GET
/prospects/{prospectID}/conversations
Retrieve all prospect conversations
getProspectConversations 7 params → 200400401403404
POST
/prospects/{prospectID}/conversations
Create a prospect conversation
createProspectConversation 1 param body → 201400401403404
GET
/prospects/{prospectID}/conversations/{conversationID}
Retrieve a prospect conversation
getProspectConversation 2 params → 200400401403404
DELETE
/prospects/{prospectID}/conversations/{conversationID}
Delete a prospect conversation (BETA)
deleteProspectConversation 2 params → 204400401403404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Prospect (51 properties), SaveProspect (30 properties), Campaign (22 properties), SaveProspectContact (10 properties). Each schema is shown below with its type and property counts.

SaveConversation
object
Conversation for Request
2 properties 2 required
RESTAPIBulkErrorResponse
object
3 properties
Prospect
object
Prospect
51 properties
RESTAPIBulkSuccessResponse
object
1 property
RESTAPIError
object
2 properties
CampaignSource
object
CampaignSource
5 properties
SaveProspectContact
object
Save Prospect Contact
10 properties 2 required
Campaign
object
Campaign
22 properties
ProspectContact
object
Contact of the prospect
8 properties
ErrorResponse
object
3 properties
Comment
object
Comment
6 properties
ResponseEntity
object
2 properties
Conversation
object
Conversation
10 properties
CustomFieldSet
object
Custom field set for Request
2 properties 2 required
SaveAddress
object
Address.
6 properties 1 required
CustomField
object
Custom field.
4 properties
ProspectStatus
object
Prospect Status
4 properties
SaveCustomField
object
Custom field for Request
2 properties 2 required
SaveProspect
object
Save Prospect
30 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

propertyware-prospects-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 Documents API
Propertyware Health check API
Propertyware Inspections API
Propertyware Leases API
Propertyware Portfolios API
Propertyware Units API
Propertyware Vendors API
Where this information came from

This is an independent, third-party profile of Propertyware Prospects 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.