API Changelog

This document tracks all changes to the Red Bricks API endpoints, including new features, modifications, deprecations, and breaking changes.

Version History

Current Version: v1.0.4

Release Date: October 21, 2025
Previous Version: v1.0.3
PHP Version: ^8.3
Active Development: Continuous development with regular updates
Lead Developer: Denis Nichik

Version Timeline

v1.0.0: Initial Launch
v1.0.1: Post-Launch Updates
v1.0.2: Search & Response Enhancement
v1.0.3: Enhanced Data Attributes & Response Improvements
v1.0.4: Relationship Resources & Data Structure Improvements (Current)

Recent Changes

Version 1.0.4 - Relationship Resources & Data Structure Improvements

Release Date: October 21, 2025 Previous Version: v1.0.3

Added

Complete Relationship Resources - Added full resource collections for related entities in project responses
- developers - Complete DeveloperResource collection replacing simple ID references
- architects - Complete ArchitectResource collection
- interior_designers - Complete InteriorDesignerResource collection
- sales_marketing_companies - Complete SalesMarketingCompanyResource collection

Updated

Enhanced Data Structure - Improved data format for better API consumption
- Better structured unit type data with consistent format
- Standardized response structures across related resources
- Formally deprecated legacy ID fields in favor of full resource collections

Deprecated

Legacy ID Fields - Formally marked several ID-only fields as deprecated
- architect_id - Now deprecated in favor of full architects resource collection
- interior_designer_id - Now deprecated in favor of full interior_designers resource collection
- developer_id - Now deprecated in favor of full developers resource collection

API Changes

For API Consumers

No Breaking Changes: All existing API calls continue to work as before
Enhanced Data: More complete relationship information in a single API call
Future Planning: Deprecation notices for legacy fields that will be removed in future versions
Better Integration: Easier integration with related resource data

For Developers

Cleaner Resource Structure: Better organized resource classes with proper relationship handling
Reduced Duplication: Eliminated duplicate data between ID fields and resource collections
Forward Compatibility: Clear migration path from legacy fields to new resource collections

Version 1.0.3 - Enhanced Data Attributes & Response Improvements

Release Date: September 24, 2025 Previous Version: v1.0.2

Added

Enhanced Name Fields in API Responses - Added human-readable name fields for better data completeness
- architect_name - Architect name in project responses (agent, enterprise subscriptions)
- interior_designer_name - Interior designer name in project responses (agent, enterprise subscriptions)
Improved Data Structure - Enhanced JSON array formatting for project data
- townhouse_types, ownership_types, low_rise_types, low_rises now properly formatted as JSON arrays

Updated

Project Resource Enhancement - Improved data formatting and deprecated field handling
- Added deprecation markers for current_psf_avg and launch_psf_avg fields
- Added GFA data sanitization to remove invalid elevatorshafts data

Breaking Changes

FloorPlan Resource Fields Removed - ⚠️ BREAKING CHANGE
- Removed pdf_url, only_for_pro, and url fields from floorplan responses
- These fields are no longer available in API responses
- Impact: Applications relying on these fields will need to be updated
- Migration: Remove references to these fields from your application code

API Changes

Enhanced Response Format

New Name Fields: architect_name, interior_designer_name added to project responses
Improved Array Formatting: All type arrays now properly formatted as JSON arrays instead of strings
Cleaner FloorPlan Responses: Removed redundant fields for more efficient data transfer
Deprecated Fields: Marked current_psf_avg and launch_psf_avg as deprecated (still functional)

For API Consumers

⚠️ Breaking Changes: FloorPlan responses no longer include pdf_url, only_for_pro, and url fields
Enhanced Data: More complete project information with architect and interior designer names
Better Performance: Optimized floorplan responses with reduced payload size
Improved Data Quality: Better formatted array data and cleaned webhook processing
Deprecated Field Notice: current_psf_avg and launch_psf_avg marked as deprecated
Migration Required: Update applications that depend on removed FloorPlan fields

For Developers

Cleaner Code Structure: Better organized resource classes with proper data formatting
Enhanced Webhook Reliability: Improved data validation and sanitization in webhook processing
Future-Ready Architecture: Proper deprecation handling for smooth API evolution
Consistent Data Types: All array fields now properly formatted as JSON arrays

Version 1.0.2 - Search & Response Enhancement

Release Date: September 06, 2025 Previous Version: v1.0.1

Added

Comprehensive Search Functionality - Added search query parameter to /api/v1/projects endpoint
- Searches across: project name, description, developer name, city name, district name, neighbourhood name
Enhanced API Response Fields - Added human-readable name fields (city_name, district_name, neighbourhood_name, developer_name) to project responses
Universal Pagination Support - Added per_page parameter support to all API endpoints
- Consistent pagination behavior across all controllers (architects, cities, developers, districts, documents, floorplans, interior designers, neighbourhoods, prices, sales marketing companies, special incentives)
- Configurable page size with bounds validation (1-50 items per page)
- Default: 20 items per page, Maximum: 50 items per page
Entity Search Endpoints - Added search parameter to all entity endpoints for autosuggest functionality
- /api/v1/architects?search=term - Search architects by name (LIKE% pattern)
- /api/v1/cities?search=term - Search cities by name
- /api/v1/developers?search=term - Search developers by name
- /api/v1/districts?search=term - Search districts by name
- /api/v1/interior-designers?search=term - Search interior designers by name
- /api/v1/neighbourhoods?search=term - Search neighbourhoods by name
- /api/v1/sales-marketing-companies?search=term - Search sales & marketing companies by name
- /api/v1/special-incentives?search=term - Search special incentives by name
Enhanced Webhook Testing - Improved test webhook functionality
- Factory-generated realistic project data for webhook testing
- Proper ProjectResource formatting matching production webhooks
- Added document webhook events support

API Changes

New Query Parameters

search - Comprehensive search across multiple fields (project name, description, developer, city, district, neighbourhood)
per_page - Number of items per page for all paginated endpoints (1-50, default: 20)
search parameter added to all entity endpoints:
- Architects, Cities, Developers, Districts, Interior Designers, Neighbourhoods, Sales Marketing Companies, Special Incentives
- Uses LIKE% pattern for autosuggest functionality (matches from beginning of name)

Enhanced Response Format

Added city_name, district_name, neighbourhood_name, developer_name fields
Maintained backward compatibility with existing field structure
No changes to existing field names or data types

For API Consumers

No Breaking Changes: All existing API calls continue to work exactly as before
Enhanced Search: New powerful search capability with single parameter
Complete Data: Reduced need for additional API calls to fetch related names
Better Performance: Optimized queries provide faster responses
Consistent Pagination: All endpoints now support per_page parameter for flexible data retrieval
Autosuggest Support: All entity endpoints now support search for building typeahead/autocomplete features
Improved Webhook Testing: Test webhooks now use realistic, factory-generated project data

For Developers

Simplified Integration: Single search parameter replaces need for complex multi-field queries
Complete Responses: All necessary data available in single API call
Clear Documentation: Updated examples and comprehensive parameter descriptions
Future-Ready: Architecture supports easy extension for additional search fields
Consistent Architecture: Standardized pagination behavior across all controllers
Factory-Based Testing: Test webhooks use realistic, varied test data
Enhanced Webhook Events: Added support for document.created and document.updated events

Version 1.0.1 - Post-Launch Updates

Release Date: August 28, 2025
Previous Version: v1.0.0

Added

API Webhook Server - Complete webhook server implementation with multiple iterations for stability
Name Filtering - Added filter by name parameter for projects endpoint
Sorting Enhancements - Added sorting by updated_at field for projects with default option

Updated

Floor Ranges - Return floor ranges as array format for better data structure
Projects Endpoint Optimization - Optimized projects endpoint response for faster data retrieval

API Changes

New Query Parameters

name - Filter projects by name
sort_by=updated_at - Sort projects by last update time
limit - Limit number of projects returned

For API Consumers

No Breaking Changes: All existing API calls will continue to work
New Features: Optional new parameters available for enhanced functionality
Performance: Existing endpoints will perform better with optimizations

For Developers

Webhook Integration: New webhook endpoints available for real-time updates
Enhanced Filtering: Additional filtering options for better data retrieval
Timezone Awareness: All date/time fields now properly handle timezones

Version 1.0.0 - Initial Launch

Release Date: August 14, 2025 Status: Initial Production Release

Core Features

API v1 Endpoints

Projects API - Complete project data with comprehensive filtering and pagination
Floorplans API - Detailed floorplan information and specifications
Documents API - Project documentation and file management
Reference Data - Cities, districts, neighbourhoods, developers, architects, interior designers, sales marketing companies, special incentives, and pricing data

Authentication & Security

Team-based API Tokens - Secure authentication system
Rate Limiting - 60 requests per minute per token
Subscription Access Control - Data access based on subscription levels
Request Logging - Comprehensive API usage tracking

Data Management

Advanced Filtering - 30+ filter parameters for projects
Pagination Support - Efficient data pagination (max 50 items per page)
Sorting Options - Multiple sorting fields and directions
Range Filters - Price, date, and size range filtering