Skip to Content
API ReferenceProperties

Properties API

CRUD endpoints for managing your property listings programmatically.

List Properties

GET /api/v1/properties

Returns a paginated list of your properties.

Query Parameters:

ParameterTypeDescription
pagenumberPage number (default: 1)
limitnumberItems per page (default: 20, max: 100)

Response:

{
  "data": [
    {
      "id": "prop_abc123",
      "address": "123 Main St, Apt 4B, New York, NY 10001",
      "rent": 2500,
      "bedrooms": 2,
      "bathrooms": 1,
      "available": true,
      "createdAt": "2025-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42
  }
}

Create Property

POST /api/v1/properties

Request Body:

{
  "address": "123 Main St, Apt 4B, New York, NY 10001",
  "rent": 2500,
  "bedrooms": 2,
  "bathrooms": 1,
  "description": "Sunny 2BR with updated kitchen and hardwood floors.",
  "available": true
}

Get Property

GET /api/v1/properties/:id

Update Property

PATCH /api/v1/properties/:id

Send only the fields you want to update.

Delete Property

DELETE /api/v1/properties/:id

Returns 204 No Content on success.

AuthenticationFAQ