Standard Operations
Portfolio resources (properties, floorplans, and units) all support the same four operations.
| Method | Path | Behavior |
|---|---|---|
GET | /v1/{resource} | List, newest first. Filterable (see each resource); all accept limit (default 50, max 200). |
POST | /v1/{resource} | Create; returns the full created object including its RentSimple id. |
PATCH | /v1/{resource}/{id} | Partial update. Send only the fields to change; returns the full updated object. |
DELETE | /v1/{resource}/{id} | Delete; returns { "message": "OK" }. |
Listing and pagination
GET returns records newest first. Every list endpoint accepts a limit query parameter:
- Default:
50 - Maximum:
200
Each resource also supports its own filters, for example city on properties, or available and availableBy on units. See each resource page for the full list.
Partial updates
PATCH is a partial update: send only the fields you want to change, and the rest are left untouched. The response is always the full, updated object.
Change one field
curl -X PATCH https://rentsimple.ai/api/v1/units/90211 \
-H "Authorization: Bearer $RENTSIMPLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "available": false }'Deletes
DELETE returns { "message": "OK" }. Note two guardrails:
- A property or floorplan must be empty before it can be deleted.
- For units, prefer
PATCHoverDELETE. An unavailable unit keeps its history, whereas a delete removes it from the agent’s knowledge entirely.
Last updated on