API Documentation - Community Floorplans

Table of Contents

Community Floorplans End-point

Returns a paginated list of floorplans associated with the community.

GET /api/v2/communities/<community_id>/floorplans/

Example response body:

{
    "page": 1,
    "total_pages": 1,
    "total_items": 2,
    "items": [
                {
                    "id": 1, 
                    "name": "Floorplan 1", 
                    "marketing_description": "Great", 
                    "unit_types": [{"id": 123, "name": "Unit A", "description": ""}],
                    "photos": [
                        {
                            "id": 32,
                            "xlarge": "https://nestio-assets-dev.imgix.net/floorplan_media/originals/68719a18f23cea739045167ce8a7023e.jpg?fit=max&h=1000&w=1000&s=84baf017ff4adc9702066a5258656be2",
                            "media_type": "Floor plan",
                            "sort_order": 0,
                            "description": null,
                            "thumbnail": "https://nestio-assets-dev.imgix.net/floorplan_media/originals/68719a18f23cea739045167ce8a7023e.jpg?fit=crop&h=70&w=100&s=f52d53ba7684b3eb4a6751d3ac0c8b9f",
                            "small": "https://nestio-assets-dev.imgix.net/floorplan_media/originals/68719a18f23cea739045167ce8a7023e.jpg?fit=crop&h=180&w=240&s=c6c77eedadc047c980a6bb6377d932d0",
                            "large": "https://nestio-assets-dev.imgix.net/floorplan_media/originals/68719a18f23cea739045167ce8a7023e.jpg?fit=crop&h=540&w=720&s=d7810a541e3e4793f1b7ee37a8742bb9",
                            "original": "https://nestiolistings-assets-dev.s3.amazonaws.com/floorplan_media/originals/68719a18f23cea739045167ce8a7023e.jpg?s=f7036da0d7dd6de17c754d5e67e087b9"
                        }
                    ], 
                    "total_rooms": {"min": 10, "max": 11}, 
                    "bathrooms": {"min": 2, "max": 4}, 
                    "square_footage": {"min": 1000, "max": 1100}, 
                    "price": {"min": "140000.00", "max": "200000.00"}
                }, 
                {
                    "id": 2, 
                    "name": "Floorplan 2", 
                    "marketing_description": "Great", 
                    "unit_types": [{"id": 456, "name": "Unit B", "description": ""}],
                    "photos": [], 
                    "total_rooms": {"min": null, "max": null}, 
                    "bathrooms": {"min": null, "max": null}, 
                    "square_footage": {"min": null, "max": null}, 
                    "price": {"min": null, "max": null}
                    
                }       
            ]
}