Skip to main content

How to generate a PropertyWare API key

R
Written by RentEngine Ops
Updated over a week ago

Overview

To connect RentEngine with PropertyWare, you must generate a PropertyWare API key. This key gives RentEngine secure access to your property, unit, and prospect data so listings and availability can sync automatically.


Before you begin

You need:

  • An active PropertyWare account

  • Admin-level access in PropertyWare to manage API keys

If you’re unsure about your access level, confirm with your PropertyWare administrator before you start.


Steps to generate a PropertyWare API key

  1. Open a web browser and sign in to your PropertyWare account.

  2. In PropertyWare, open the Setup page.

  3. In the left sidebar, expand Administration Setup.

  4. Click API Keys.

  5. Click Create API Key. A modal will open.

  6. Enter a clear, memorable Name and optional Description for the API key.

    • Use a name that helps you identify this key later, like "RentEngine"

  7. Choose the following permissions:

    1. Buildings: READ

    2. Units: READ

    3. Prospects: WRITE (only if using RentEngine Applications)

    4. Documents: WRITE (only if using RentEngine Applications)

  8. Click Generate Key.

PropertyWare will display your new API key details, including:

  • Organization ID

  • Client ID

  • Client secret


What to do with your API key

After generating the key, send the following to your RentEngine onboarding manager:

  • Organization ID

  • Client ID

  • Client secret

RentEngine uses these values to authenticate with PropertyWare and complete the integration setup.


Important tips

  • Store the key securely. Treat the client secret like a password — don’t share it publicly or include it in insecure locations.

  • If you regenerate or delete an API key, update RentEngine with the new credentials.


Troubleshooting

I don’t see “API Keys” in Setup
Your PropertyWare user may not have admin access. Ask your PropertyWare administrator to grant you access to Administration Setup > API Keys.

My key isn’t working in RentEngine

  • Confirm the Organization ID, Client ID, and Client secret were entered correctly.

  • Ensure the API key has access to the required PropertyWare data types.

  • If issues persist, contact your RentEngine onboarding manager

Did this answer your question?