API Documentation

Integrate your BookMyColiving leads into your CRM, Zapier workflows, or custom applications.

Authentication

All API requests require an API key sent via the x-api-key header. You can generate your API key from the Dashboard Settings page.

curl -H "x-api-key: bmc_your_api_key_here" \
  https://bookmycoliving.com/api/v1/leads

GET/api/v1/leads

Retrieve your leads with optional filtering and pagination.

Query Parameters

Parameter	Type	Default	Description
page	integer	1	Page number for pagination
limit	integer	20	Results per page (max 100)
propertyId	string	—	Filter leads by property ID
since	ISO 8601	—	Only return leads created after this date

Example Response

{
  "leads": [
    {
      "id": "clx1abc...",
      "propertyId": "clx2def...",
      "propertyName": "Sunset Coliving Bangkok",
      "propertySlug": "sunset-coliving-bangkok",
      "guestName": "Jane Smith",
      "guestEmail": "jane@example.com",
      "guestPhone": "+1234567890",
      "moveInDate": "2025-03-01T00:00:00.000Z",
      "lengthOfStay": "3 months",
      "message": "Interested in a private room",
      "sourcePage": "/city/bangkok",
      "createdAt": "2025-02-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "totalPages": 3
  }
}

Webhooks

Set a Webhook URL in your Dashboard Settings to receive real-time notifications when new leads come in. We'll send a POST request to your URL with the lead data.

Webhook Payload

{
  "event": "lead.created",
  "data": {
    "id": "clx1abc...",
    "propertyId": "clx2def...",
    "propertyName": "Sunset Coliving Bangkok",
    "guestName": "Jane Smith",
    "guestEmail": "jane@example.com",
    "guestPhone": "+1234567890",
    "moveInDate": "2025-03-01T00:00:00.000Z",
    "lengthOfStay": "3 months",
    "message": "Interested in a private room",
    "createdAt": "2025-02-15T10:30:00.000Z"
  }
}

Code Examples

JavaScript / Node.js

const response = await fetch("https://bookmycoliving.com/api/v1/leads?limit=50", {
  headers: { "x-api-key": "bmc_your_api_key_here" },
});
const { leads, pagination } = await response.json();
console.log(`Found ${pagination.total} leads`);

cURL

# Fetch all leads
curl -H "x-api-key: bmc_your_api_key_here" \
  "https://bookmycoliving.com/api/v1/leads"

# Fetch leads since a specific date
curl -H "x-api-key: bmc_your_api_key_here" \
  "https://bookmycoliving.com/api/v1/leads?since=2025-01-01T00:00:00Z"

# Fetch leads for a specific property
curl -H "x-api-key: bmc_your_api_key_here" \
  "https://bookmycoliving.com/api/v1/leads?propertyId=clx2def..."

Zapier Integration

To integrate with Zapier, use the Webhooks by Zapier trigger:

Create a new Zap and choose "Webhooks by Zapier" as the trigger
Select "Catch Hook" as the trigger event
Copy the webhook URL provided by Zapier
Paste it as your Webhook URL in Dashboard Settings
Create a test lead on your property to verify the connection
Set up your action (e.g., add to Google Sheets, send to CRM, email notification)

Rate Limits

The API is rate limited to 10 requests per minute per API key. If you exceed this limit, you'll receive a 429 response.