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.
Before you begin, please make sure that:
- 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. - Your PropSpace account can generate 1 Website API key.
The API key can be used to:
- Retrieve property listings from PropSpace.
- Sync listing updates with external websites.
- Access property data through the Website API endpoints.
🔐 Important security note:
- Once the API key is created, you must copy and securely store the API Key immediately.
- Treat the key as confidential. Do not place it in email, chat, screenshots or source code that is publicly accessible.
- For security reasons, the key will not be visible again after the creation dialogue is closed.
- You will also be required to tick the confirmation checkbox before completing the creation.
- If you need a new key, you can regenerate it.
- 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:
Log in to your account > Go to Admin > Click on Profile > Open Developer Settings > Click 'Website API Key'.
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.
You can see the timestamp for when the key was generated.