Skip to main content
GET
/
v1
/
properties
List Properties
curl --request GET \
  --url https://api.trellistech.com/v1/properties \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "address": "<string>",
      "city": "<string>",
      "country": "<string>",
      "bedrooms": 123,
      "bathrooms": 123,
      "max_guests": 123,
      "status": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
Returns a paginated list of properties in your workspace. Use query parameters to filter by status or paginate through results.
List responses return a summary of each property. To retrieve the full object — including amenities, media, and custom fields — use the Get Property endpoint.

​
Query Parameters

​
status
string
Filter properties by their current status. One of: ACTIVE, INACTIVE, ONBOARDING, LEAD, PAUSED, CHURNED.
​
limit
integer
default:"50"
Maximum number of properties to return (1—100).
​
offset
integer
default:"0"
Number of properties to skip for pagination.

​
Example Request

curl -H "Authorization: Bearer trls_live_abc123..." \
  "https://api.trellistech.com/v1/properties?status=ACTIVE&limit=10"

​
Response

​
data
array
Array of property objects.
​
total
integer
Total number of properties matching the filter criteria.
​
limit
integer
The limit used for this request.
​
offset
integer
The offset used for this request.

​
Example Response

200
{
  "data": [
    {
      "id": "a1b2c3d4-5678-9abc-def0-123456789abc",
      "name": "Sunset Villa",
      "address": "123 Ocean Drive",
      "city": "Miami Beach",
      "country": "US",
      "bedrooms": 3,
      "bathrooms": 2.5,
      "max_guests": 8,
      "status": "ACTIVE",
      "created_at": "2025-06-15T10:30:00Z",
      "updated_at": "2026-03-20T14:45:00Z"
    },
    {
      "id": "b2c3d4e5-6789-abcd-ef01-23456789abcd",
      "name": "Mountain Retreat",
      "address": "456 Pine Ridge Road",
      "city": "Aspen",
      "country": "US",
      "bedrooms": 5,
      "bathrooms": 4,
      "max_guests": 12,
      "status": "ACTIVE",
      "created_at": "2025-08-01T09:00:00Z",
      "updated_at": "2026-02-10T11:20:00Z"
    }
  ],
  "total": 47,
  "limit": 10,
  "offset": 0
}

​
Error Responses

401
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}
400
{
  "error": {
    "code": "invalid_parameter",
    "message": "The 'status' parameter must be one of: ACTIVE, INACTIVE, ONBOARDING, LEAD, PAUSED, CHURNED."
  }
}