Skip to main content

Developer Overview

Everything you need to build integrations with PropertyBase.

Getting Started​

Prerequisites​

  • PropertyBase Professional or Enterprise plan
  • API access enabled on your account
  • Basic understanding of REST APIs

Quick Start​

  1. Get API Key: Go to Settings > API Keys > Create Key
  2. Make First Request:
curl -X GET "https://api.propertybase.ai/v1/properties" \
  -H "Authorization: Bearer YOUR_API_KEY"
  1. Explore the API: Use our API Reference

Developer Resources​

Documentation​

Tools​

  • API Explorer - Interactive API testing
  • Webhook Tester - Test webhook deliveries
  • Sandbox Environment - Safe testing environment

Integration Patterns​

Server-to-Server​

For backend integrations:

// Node.js example
import { PropertyBase } from '@propertybase/sdk';

const client = new PropertyBase({
  apiKey: process.env.PROPERTYBASE_API_KEY,
});

const leads = await client.leads.list({ status: 'new' });

OAuth Applications​

For user-facing apps:

// Redirect user to authorize
const authUrl = `https://auth.propertybase.ai/oauth/authorize?
  client_id=${CLIENT_ID}&
  redirect_uri=${REDIRECT_URI}&
  response_type=code&
  scope=read:leads write:leads`;

window.location.href = authUrl;

Webhooks​

For real-time updates:

// Receive webhook events
app.post('/webhooks/propertybase', (req, res) => {
  const event = req.body;

  switch (event.event) {
    case 'lead.created':
      handleNewLead(event.data);
      break;
    case 'deal.closed':
      handleClosedDeal(event.data);
      break;
  }

  res.status(200).send('OK');
});

Sandbox Environment​

Test your integration safely:

  • URL: https://api.sandbox.propertybase.ai/v1
  • Data: Reset weekly
  • Rate Limits: Same as production
  • Webhooks: Full support

Creating Sandbox Keys​

  1. Go to Settings > API Keys
  2. Click Create Sandbox Key
  3. Use with sandbox URL

Rate Limits​

PlanRequests/minDaily Limit
Professional12050,000
Enterprise600Unlimited

See Rate Limits for details.

Support​

Developer Support​

Enterprise Support​

  • Dedicated solutions engineer
  • Priority issue resolution
  • Custom integration assistance

Changelog​

Stay updated with API changes:

  • Changelog - All updates
  • Email notifications (Settings > Notifications)