Welcome to Propertyware’s API—a powerful, RESTful programming interface that lets you leverage valuable Propertyware data.

Before you can use Propertyware’s API, you’ll need to make some tweaks to your account settings.

Enabling the API

In order to start creating your keys and making requests, you’ll need to enable the API.

Tip: You’ll need an administrator user role with access to Administration Setup > API Keys to set things up properly.

Let's Begin!

1. Sign in to your Propertyware account from your browser.

2. Open the Setup page

3. On the left navigation bar, expand Administration Setup and then click API Keys.

If you are having issues accessing the API keys page within your account you can submit a Support request for assistance.

Account-level API keys authenticate every request and keep things secure.

API keys have two components: a “client ID” and a “secret”.

• Client IDs are similar to usernames. They’re used to identify your Propertyware API key and are safe to share.
• Secrets are similar to passwords. They must be kept confidential.

Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a 401 response code.

Tip: We compiled a list of best practices that detail how securely store API keys. Give it a read!

Now that the Open API is enabled, you’ll be able to create API keys. You’re almost there!

How to create an API key

1. On the API Keys page, click Create API Key. A modal will appear.

2. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request.

3. Now, choose which pieces of Propertyware data you want this API key to have access to by selecting the corresponding radio buttons. Once finished, click GENERATE KEY.

4. You have successfully created an API key! The client id and secret associated to this key will be presented.

Important: This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch.

You have now successfully created an API key and have everything you need to send requests to the Propertyware API!

Before moving on to making your first request please review Keeping API Keys Safe for an overview on securely storing your API keys.

If you are having issues creating API keys you can submit a Support request for assistance.

Based on their permissions, API keys could have full access to your account’s Propertyware data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized.

Recommended Practices

• Avoid hard-coding client IDs and secrets inside source files.
• Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms.
• Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Propertyware entities or to read-only access (GET resources only).
• Avoid sharing client IDs and secrets across public, insecure platforms.
• Establish a process to regularly recreate your client IDs and secrets from your Propertyware account.
  
  

You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes!

Tip: Looking for the right HTTP client? If you’re just getting started, we recommend Postman.

Let's Get Started!

Step 1: Get Your API Key

If you haven't yet done so, obtain your API key client ID and secret from your Propertyware account. Your API key is how the Propertyware API authenticates requests and ensures only you can access your data.

Step 2: Install a HTTP client

The Propertyware API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend Postman – it allows you to access the Propertyware API without writing code. We’ll use Postman for our example below to demonstrate sending an API request.

Step 3: Make a Sample Request

Let's dive in and make a simple request to get all the Buildings in your account. This will confirm your connectivity to our platform and validate the keys you created on our website. Simply follow the instructions below.

1. Open the Postman application.
2. Open the verb menu and select GET.
3. Enter the request endpoint in the field next to GET.
   • Here’s the endpoint to get all buildings: https://api.propertyware.com/pw/api/rest/v1/buildings.
4. To authenticate the request, enter your client ID, your secret and your organization iD respectively in these request headers:
   • x-propertyware-client-id
   • x-propertyware-client-secret
   • x-propertyware-system-id (organization id)

The organization id uniquely identifies your Propertyware account and is an additional measure to enforce proper access to the correct data. Your client id and secret pair will only work with the organization it belongs to.

Your full request should look similar to the image below.

5. Review the parameters of your request on last time. Once finished, click Send.

6. If successful, you should see a JSON response and a 200 HTTP status code. Congratulations! You've connected to the Propertyware API.

You now have the knowledge required to make requests for any of our resources.

If you've received an error response please review the JSON response message for a description of how to resolve the issue. You can also see more information about HTTP status codes in the Response Codes section. If you are still having trouble making a request after reviewing these sections please submit a Support request.

The Propertyware API is built upon standard REST conventions. It's designed to use consistent resource-oriented URLs, accept and return JSON-encoded messages, and use standard HTTP status codes and verbs.

The base URL for production environment API requests is: https://api.propertyware.com/pw/api/v1/rest

In order to ensure all requests and responses are secure between the API consumer and Propertyware servers, requests must be made using the https protocol. Any requests not made with the https protocol will be refused by the Propertyware API platform.

Note: URL paths are case-sensitive to stay consistent with common REST standards. If your request doesn’t align with the documented URL path, you’ll receive a 404 response code reminding you of this constraint.

The Propertyware API is version controlled. Versioning ensures backwards-incompatible changes to the API don’t impact any existing integrations.

Propertyware uses only a major version nomenclature to manage changes. The current version of the Propertyware API is version 1. By specifying a version in the resource request URL, you'll get expected responses regardless of future changes to the API. Here's an example of calling version 1 of the retrieve all leases resource:

https://api.propertyware.com/pw/api/rest/v1/leases

Any request submitted without the version in the URL path will result in a 404 error response code.

Releasing Changes to the API

The Propertyware API will continue to evolve to ensure it meets the needs of our customers. Changes will be defined as either backwards-compatible or backwards-incompatible.

We’ll provide advance notice for all API releases–regardless of the type of modifications being made.

Backward-compatible Changes

Backward-compatible changes are modifications to the API that shouldn't impact existing integrations. They'll apply to the current version of the API. Simply put: you won’t need to change the version to consume new changes like these.

It's important as you develop against the Propertyware API that you ensure these types of changes don't impact your integration. Here's are examples of backward-compatible modifications.

• Adding new API resources and/or endpoints.
• Adding new optional request parameters to existing API methods.
• Adding new properties to existing API responses and non-required properties for request messages.
• Changing property order in existing API responses.

All backward-compatible changes to the API will be documented in the Changelog.

Backwards-incompatible Changes

When backwards-incompatible changes to the API occur, a new version of the API will be released. You’ll need to update the URL path to consume resources under the new API version.

Backwards-incompatible changes include:

• Removing a property from a request and/or response message.
• Changing the name of a property in a message.
• Adding a required parameter to a request message.
• Changing existing enumeration values.

New versions of the API will have full reference documentation and an upgrade guide.

The Propertyware API uses API key’s client IDs and secrets to authenticate requests.

An organization ID, an API key client ID and secret must be passed in every request header using the following parameters:

• x-propertyware-client-id
• x-propertyware-client-secret
• x-propertyware-system-id

Failing to provide both of them in the request header will cause the API to return a 401 HTTP status code.

All top-level API resources support bulk fetches. For instance, you can retrieve all Portfolios. These resources also allow for filtering criteria. Each resource has descriptions of the filter criteria available.

In addition to filtering, our API gives you the ability to control the returned data’s pagination and the sort order.

Pagination

Endpoints that return result sets allow for pagination using limit and offset request parameters to reduce the amount of data returned.

The limit request parameter will cap the number of results that come back in the response. If you don't specify a limit value, a default of 100 results are returned. The maximum limit value is 500. If a limit value is specified greater than 500, it will be overridden to the default to 500.

The offset request parameter indicates the record position within the resultset to start at when returning the results. The offset is zero-based and is inclusive. If no offset value is submitted it will default to 0.

The total resultset count is returned in the HTTP Header X-Total-Count

Pagination Example

As an example, let's say we make a request to retrieve all rental properties with no paging parameters. Our response indicates in the X-Total-Count header that there are 150 total rental properties. We want to get only the last 50 results so we would submit a request with the offset set to 100 and the limit set to 50.

Note: The limit and offset parameter names are case-sensitive. If they aren't formatted correctly, the API will return a 404 HTTP status code.

Sorting Results

You can specify the sort order of returned data by assigning properties from the returned object to the orderby parameter in the querystring. For example:

orderby=name

By default, the sort is performed in ascending order. To specify sort order, use "asc" for ascending or "desc" for descending. For example:

orderby=name desc

Additionally, you can sort by multiple properties by comma separating the properties. For example:

orderby=abbreviation asc,name desc

Note: While the orderby parameter is case-sensitive, the properties specified in the orderby value aren't.

The Propertyware API supports standard HTTP status codes.

• For all request and response date fields allowing ISO date format: YYYY-MM-DD (e.g.2019-08-24).
• For all request and response dateAndTime fields format is allowing: YYYY-MM-dd'T'HH:mm:ssXXX (e.g.2022-06-28T08:47:13Z).

If you are unable to resolve your issue after reviewing the API documentation our support team can assist you.

2024-05-12

• A new filed "arBalance" is added to Lease response for below end points
  • Retrieve a lease ( GET - /leases/{leaseID} - set query parameter "includeOtherBalances = true" to include lease arBalance)
  • Retrieve all leases ( GET - /leases )
  • Create a lease (POST - /leases)
  • Update a lease (PUT - /leases/{leaseID})

2024-04-23

• Beta has been removed to facilitate Update an owner draw ( PUT - /accounting/ownerdraws/{drawID} )

2024-04-10

• Beta has been removed to facilitate Update a Credit ( PUT - /bills/credit/{creditID} )
• Beta has been removed to facilitate Update a Bill ( PUT - /bills/{billId} )
• Beta has been removed to facilitate Create word orders in bulk. ( POST - /workorders/bulk )
• A new field "amount" is added to Bill response for below end points
  • Retrieve a bill ( GET - /bills/{billID} )
  • Retrieve all bills ( GET - /bills/ )
  • Create a Bill ( POST - /bills/ )
  • Update Bill ( PUT - /bills/{billId} )
  • Create a Credit ( POST - /bills/credit )
  • Update a Credit ( PUT - /bills/credit/{creditID} )
• Update a Contact ( PUT - /contacts/{contactID} ) is allowed to update any Contact Type
• A new field "managementFeesType" is added to CREATE building(POST), UPDATE building(PUT), GET buildings(GET) end points. Existing "managementFeeType" is deprecated and should not be used.
• Few fields from CREATE building are not updating with a POST request. Resolved the issue and impacted fields are targetDeposit, targetRentUnits.
• Few fields from UPDATE building are not updating with a PUT request. Resolved the issue and impacted fields are numberOfBathrooms, numberOfBedRooms, targetRent, targetDeposit, targetRentUnits, marketingName, managementFlatFee, managementFeeType, petsAllowed, postingTitle, shortDescription, yearBuilt.
• The 'account' field has been removed, and the data type for the 'dueDay' field has been changed from String to Integer in the response for the ( POST - /leases/autocharges ) endpoint.
• Fixed the issue - date field value getting saved as today date for Create Lease Charge, Update Lease Charge, Create Bulk Charges, Create a Lease Payment, Update a Lease Payment, Create a Lease Refund APs.
• Work order id validation is implemented for Create Bill, Update Bill, Create Credit, Update Credit APIs.

2024-03-24

• New API introduced to update existing workorder custom fields.
  URL : /workorders/customfields (PUT)
  Access Permissions : WorkOrder - Write
• A new field "role" is added to GET lease contacts end point (/leases/{leaseID}/contacts)
• A new field "role" is added to "contact" in GET lease end point (/leases/{leaseID})
• A new field "role" is added to "contact" in GET All leases end point (/leases)

2024-03-11

• New API introduced to update existing contact custom fields.
  URL : /contacts/customfields (PUT)
  Access Permissions : Contacts - Write
• Beta has been removed to facilitate create a bank deposit, create an owner contribution, create an owner draw requests.
• New API introduced to update existing portfolio custom fields.
  URL : /portfolios/customfields (PUT)
  Access Permissions : Portfolio - Write
• New API introduced to update existing vendor custom fields.
  URL : /vendors/customfields (PUT)
  Access Permissions : Vendor - Write
• Beta has been removed to facilitate 'Create a bill', 'Create bills in bulk', 'Create a credit' Rest API's.

2024-02-25

• Beta has been removed to facilitate 'Retrieve all bills','Retrieve all bill payments','Retrieve a bill payment','Retrieve all vendor checks' and 'Retrieve a bill'.

• Create/update/Retrieve VendorCheck endpoint change from bills/vendorChecks to bills/vendorChecks.

• A new API has been introduced to enable adding multiple automatic charges to leases.
  URL : /leases/autocharges (POST)

• General ledger GET end point('/accounting/generalledger') is updated to filter only 7 days duration of transactions earlier it is 30 days.

• New field added "referenceNumber" in "rentAutoCharge" of create lease request.

• New API introduced to update unit custom fields
  URL : /units/customfields (PUT)
  Access Permissions : Unit - Write

• New API introduced to update building custom fields
  URL : /buildings/customfields (PUT)
  Access Permissions : Building - Write

2024-02-11

• Beta has been removed to facilitate Retrieves a list of owner draws,Retrieves a list of owner contributions,Retrieves a list of general ledger accounts and Retrieves a general ledger account.
• New filed "description" is added in General ledger account(accounting/glaccounts - GET & accounting/glaccounts/{glAccountID} - GET) endpoint response.
• New field "specificLocation" is added in Workorder create/update request.
• New field "requiredMaterials" is added in Workorder create/update request.
• New field "publishToTenantPortal" is added in Workorder create/update request.
• New field "publishToOwnerPortal" is added in Workorder create/update request.
• New field "publishToTenantPortal" is added in Workorder GET response.
• New field "publishToOwnerPortal" is added in Workorder GET response.
• New API introduced to update lease custom fields
  URL : /leases/customfields (PUT)
  Access Permissions : Lease - Write (An additional permission is required "Custom Field - write" will be introduced with 2024-02-25 release)
• New API introduced to update prospect custom fields
  URL : /prospects/customfields (PUT)
  Access Permissions : prospect - Write (An additional permission is required "Custom Field - write" will be introduced with 2024-02-25 release)

2024-01-24

• Beta has been removed to facilitate WorkOrder task update.
• Beta has been removed to facilitate retrieve vendor general ledger account.
• New field "source" is added in Workorder create/update request.
• Beta has been removed to facilitate Unit update.

2024-01-09

• An additional property , 'ready' (indicating ready to lease), has been added to create the building API. However, the 'unitCount' property value is incorrect when using the create building API.

• Beta has been removed to facilitate building updates and creation in bulk for Building APi.

• "Retrieve all lease journal entries". this is an extension for existing endpoint. leaseID will be part of the request params in new endpoint.
  existing url: https://api.propertyware.com/pw/api/rest/v1/leases/journalentries/{leaseID} (Will be discontinued in future once new URL is being used)
  New url: https://api.propertyware.com/pw/api/rest/v1/leases/journalentries (leaseID can be sent as a request parameters)

• "Retrieve all lease auto charges". this is an extension for existing endpoint. leaseID will be part of the request params in new endpoint.
  existing url: https://api.propertyware.com/pw/api/rest/v1/{leaseID}/autocharges (Will be discontinued in future once new URL is being used)
  New url: https://api.propertyware.com/pw/api/rest/v1/leases/autocharges (leaseID can be sent as a request parameters)

• New field "publishedForRent" is added in Building and Unit responses.

• New field "role" is added in prospect contact response.

• Beta has been removed to facilitate Contact update.

• Allowed GET Lease charges/payments/refunds/creditmemos/adjustments, filtered by "glAccountId"

2023-10-24

• Retrieve a General Ledger Account

2023-08-28

• Update a document

2023-07-11

• Delete a document

2023-07-11

• Retrieve all documents
• Retrieve a document
• Download a document

2023-06-10

• Lease contacts are included in Retrieve all leases API response
• Lease contacts are included in Retrieve a lease API response

2023-04-24

• Bulk Insertion: Prospects
• Bulk Insertion: Bill Payments

2023-04-11

• Bulk Insertion: Portfolios
• Bulk Insertion: Buildings
• Bulk Insertion: Units

2023-03-19

• Bulk insertion: contacts

2023-03-08

• Bulk insertion: bills

2023-01-24

• Custom fields in "Get all" endpoints
• Prospect creation
• Bill removals

2022-10-25

• API Read operations for non-financial data

2022-09-21

• API Read operations available

Resources providing access to accounting data such as general ledger accounts and financial transactions.

Resources providing access to bills and bill payments.