Generate an API key for Website Management in PropSpace

Generate an API key for Website Management in PropSpace

How to generate a Website API key in PropSpace

This article explains how to generate a Website API Key that can be used to retrieve property listings and related data from your PropSpace account for website integrations.


✅ Prerequisites

Before you begin, please make sure that:
  1. You have Super Manager access in your account.
    If you are not sure whether you have Super Manager access, please contact the Support team to confirm.
  2. Your PropSpace account can generate 1 Website API key.
The API key can be used to:
  1. Retrieve property listings from PropSpace.
  2. Sync listing updates with external websites.
  3. Access property data through the Website API endpoints.

Alert
🔐 Important security note:
  1. Once the API key is created, you must copy and securely store the API Key immediately. 
  2. Treat the key as confidential. Do not place it in email, chat, screenshots or source code that is publicly accessible.
  3. For security reasons, the key will not be visible again after the creation dialogue is closed.
  4. You will also be required to tick the confirmation checkbox before completing the creation.
  5.  If you need a new key, you can regenerate it.
    1. Warning: Regenerating will invalidate your current key. Before you regenerate, communicate this to the developer. 

🛠 How to create a Website API key

📝 Key details to complete:
  1. Log in to your account > Go to Admin > Click on Profile > Open Developer Settings > Click 'Website API Key'.
          
  1. After the key is created, a dialogue box will appear. Copy and securely save the API Key, and tick the confirmation checkbox to complete the process. 
    Note: The key cannot be retrieved again after this step.
  2. You can see the timestamp for when the key was generated. 

📚 Resources
For more detailed information and to explore the API endpoints, please refer to the official documentation and Postman collections: https://website-api-docs.propspace.com/ 

If you encounter any issues or errors, please contact the Support team at support@propspace.com  for assistance.