Skip to main content
GET
/
v1
/
reservations
List Reservations
curl --request GET \
  --url https://api.trellistech.com/v1/reservations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "property_id": "<string>",
      "property_name": "<string>",
      "guest_name": "<string>",
      "guest_email": "<string>",
      "guest_phone": "<string>",
      "check_in": "<string>",
      "check_out": "<string>",
      "guests": 123,
      "source": "<string>",
      "status": "<string>",
      "total_amount": 123,
      "currency": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
Returns a paginated list of reservations. Use query parameters to filter by property, status, or check-in date range.
List responses return a summary of each reservation. To retrieve the full object — including detailed guest information, financial breakdowns, and custom fields — use the Get Reservation endpoint.

Query Parameters

property_id
string
Filter reservations by a specific property ID.
status
string
Filter by reservation status. One of: CONFIRMED, CHECKED_IN, CHECKED_OUT, CANCELLED, PENDING.
checkin_from
string
Return reservations with check-in on or after this date (ISO 8601 format, e.g., 2026-04-01).
checkin_to
string
Return reservations with check-in on or before this date (ISO 8601 format, e.g., 2026-04-30).
limit
integer
default:"50"
Maximum number of reservations to return (1—100).
offset
integer
default:"0"
Number of reservations to skip for pagination.

Example Request

curl -H "Authorization: Bearer trls_live_abc123..." \
  "https://api.trellistech.com/v1/reservations?checkin_from=2026-04-01&checkin_to=2026-04-30&limit=20"

Response

data
array
Array of reservation objects.
total
integer
Total number of reservations 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": "r1a2b3c4-5678-9abc-def0-111111111111",
      "property_id": "a1b2c3d4-5678-9abc-def0-123456789abc",
      "property_name": "Sunset Villa",
      "guest_name": "Maria Garcia",
      "guest_email": "maria.garcia@example.com",
      "guest_phone": "+1-555-0123",
      "check_in": "2026-04-10",
      "check_out": "2026-04-15",
      "guests": 4,
      "source": "Airbnb",
      "status": "CONFIRMED",
      "total_amount": 1250.00,
      "currency": "USD",
      "created_at": "2026-03-01T08:00:00Z",
      "updated_at": "2026-03-15T12:30:00Z"
    },
    {
      "id": "r2b3c4d5-6789-abcd-ef01-222222222222",
      "property_id": "b2c3d4e5-6789-abcd-ef01-23456789abcd",
      "property_name": "Mountain Retreat",
      "guest_name": "James Chen",
      "guest_email": "james.chen@example.com",
      "guest_phone": "+1-555-0456",
      "check_in": "2026-04-20",
      "check_out": "2026-04-27",
      "guests": 6,
      "source": "Booking.com",
      "status": "CONFIRMED",
      "total_amount": 2800.00,
      "currency": "USD",
      "created_at": "2026-03-10T15:00:00Z",
      "updated_at": "2026-03-10T15:00:00Z"
    }
  ],
  "total": 23,
  "limit": 20,
  "offset": 0
}

Error Responses

400
{
  "error": {
    "code": "invalid_parameter",
    "message": "The 'checkin_from' parameter must be a valid ISO 8601 date."
  }
}
401
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}