Listings API

The Listings API allows you to programmatically create and manage property listings.

Endpoints

List all listings

GET /v1/listings

Returns a paginated list of all your listings.

Query Parameters

• page - Page number (default: 1)
• limit - Items per page (default: 20, max: 100)
• status - Filter by status: draft, active, archived

Response

{
  "data": [
    {
      "id": "lst_abc123",
      "address": "123 Main St, City, ST 12345",
      "beds": 4,
      "baths": 3,
      "sqft": 2500,
      "status": "active",
      "created_at": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45
  }
}

Get a listing

GET /v1/listings/:id

Returns a single listing with all details.

Create a listing

POST /v1/listings

Request Body

{
  "address": "123 Main St, City, ST 12345",
  "beds": 4,
  "baths": 3,
  "sqft": 2500,
  "description": "Beautiful family home...",
  "mls_number": "MLS12345"
}

Update a listing

PATCH /v1/listings/:id

Updates the specified fields on a listing.

Delete a listing

DELETE /v1/listings/:id

Permanently deletes a listing and all associated media.

Media Endpoints

Upload media

POST /v1/listings/:id/media

Upload photos, videos, or documents to a listing.

List media

GET /v1/listings/:id/media

Returns all media for a listing.

Delete media

DELETE /v1/listings/:id/media/:media_id

Removes a specific media item from a listing.