Developer tools / Sandbox

API Sandbox Testing

Test the Coliving API integration in a safe environment

Safe Testing Environment

Sandbox Environment: This is a testing environment where you can try the API endpoints without creating real data. All responses are mock data and no actual users, bookings, or listings are created.

Test Data

Use these pre-defined IDs for testing the API endpoints:

Users

ID: 1001 - John Doe (john.doe@example.com)

ID: 1002 - Jane Smith (jane.smith@example.com)

Listings

ID: 2001 - Cozy Downtown Apartment (NYC)

ID: 2002 - Modern City Loft (San Francisco)

Room Types

ID: 3001 - Private Room (Listing 2001)

ID: 3002 - Shared Room (Listing 2001)

ID: 3003 - Studio Apartment (Listing 2002)

Test User Creation

Try creating a user with the sandbox endpoint:

POST /sandbox/users

First Name *

Last Name *

Email *

Password *

Phone

Country

City

Timezone

Date of Birth

Gender

Language

Test Booking Creation

Try creating a booking with the sandbox endpoint:

POST /sandbox/bookings

Test Listing Create / Update

Mock POST/PATCH/GET for listings. Nothing is written to the listings table. Use the id from POST in PATCH or GET.

These paths are sandbox-only. Production create/update remains POST/PATCH /v1/listings. POST/PATCH still return a sparse data object; GET returns the full cached listing. The sample bodies match the listings import catalog; amenity and enum IDs come from /json/import/*.

POST /sandbox/listings
PATCH /sandbox/listings/{id}
GET /sandbox/listings/{id}

Create (POST)

JSON body *

{
    "original_id": "property-01",
    "original_url": "https://host.example.com/listings/property-01",
    "name": "300 Mountain Road",
    "property_size": 2500,
    "property_size_unit": "m2",
    "parking": "Parking on street (free)",
    "internet_download": 300,
    "internet_upload": 150,
    "bedrooms": 10,
    "bathrooms": 8,
    "residents": 18,
    "descriptions": {
        "property": "Bright shared home with work-ready common areas.",
        "neighborhood": "Walkable area near transit and cafes.",
        "community": "Residents are social, respectful, and internationally minded."
    },
    "location": {
        "address": "300 Mountain Road",
        "zip": "90210",
        "neighborhood": "Mission District",
        "city": "San Francisco",
        "state": "California",
        "country": "United States",
        "lat": 37.8081823,
        "lng": -122.4141216
    },
    "amenities": [
        {
            "id": 12
        }
    ],
    "prices": {
        "currency": "usd",
        "security_deposit_type": "fixed",
        "security_deposit": 1000,
        "extra_fees": [
            {
                "name": "Cleaning fee",
                "description": "One-time cleaning fee",
                "mandatory": 1,
                "type": "fixed",
                "sum": 120,
                "frequency": "once"
            }
        ]
    },
    "room_types": [
        {
            "original_id": "private-queen-01",
            "name": "Private queen room",
            "room_type": "private",
            "bed_type": "queen",
            "application_url": "https://host.example.com/apply/private-queen-01",
            "room_size": 180,
            "room_size_unit": "sqft",
            "max_occupancy": 2,
            "gender": "mixed",
            "bathroom_type": "private",
            "available_at": "2026-03-16",
            "rooms": [
                {
                    "original_id": "room-104",
                    "name": "Room 104",
                    "description": "Quiet room with desk and closet.",
                    "availability": {
                        "ical": "https://host.example.com/ical/room-104.ics"
                    }
                }
            ],
            "prices": {
                "base_price": 1200,
                "price_jan": 1200,
                "price_feb": 1200,
                "price_mar": 1200,
                "price_apr": 1250,
                "price_may": 1250,
                "price_jun": 1300,
                "price_jul": 1300,
                "price_aug": 1300,
                "price_sep": 1250,
                "price_oct": 1250,
                "price_nov": 1200,
                "price_dec": 1200,
                "discount_90": 5,
                "discount_180": 10,
                "discount_360": 15
            },
            "amenities": [
                {
                    "id": 34
                }
            ],
            "photos": [
                {
                    "url": "https://assets.host.example.com/room-104.jpg",
                    "description": "Desk and window"
                }
            ]
        }
    ],
    "bookings": {
        "stay_min": 3,
        "notice_min_days": 14,
        "move_in_max_days": 90,
        "application_url": "https://host.example.com/apply/property-01",
        "cancellation_policy": "flexible",
        "booking_rules": "No overnight guests without approval."
    },
    "community": {
        "age_min": 25,
        "age_max": 45,
        "age_avg": 31,
        "gender": "mixed",
        "gender_ratio": 50,
        "events": [
            {
                "id": 1061
            }
        ],
        "community_manager": {
            "name": "Jeff",
            "photo": "https://assets.host.example.com/community-manager.jpg",
            "onsite": 1
        },
        "types": [
            {
                "id": 8
            }
        ]
    },
    "media": {
        "3d_tour": "https://my.matterport.com/show/?m=123456789",
        "video_tour": {
            "type": "youtube",
            "url": "https://www.youtube.com/watch?v=fYfFgcBlxrQ"
        },
        "photos": {
            "property": [
                {
                    "url": "https://assets.host.example.com/property-01.jpg",
                    "description": "Coworking lounge"
                }
            ],
            "community": [
                {
                    "url": "https://assets.host.example.com/community-01.jpg",
                    "description": "Community dinner"
                }
            ]
        }
    },
    "instructions": {
        "check_in_earliest": "14:30",
        "check_in_latest": "20:00",
        "check_out_latest": "11:00",
        "check_in_contact_person": "Sandra",
        "check_in_telephone_country": "+1",
        "check_in_telephone_number": "5551234567",
        "check_in_instructions": "Use the keypad at the main entrance.",
        "directions": "From the airport, take the express train to Downtown Station.",
        "house_manual": "Quiet hours start at 10pm. Clean shared areas after use."
    },
    "faq": [
        {
            "question": "Is cleaning included?",
            "answer": "Yes, common areas are cleaned weekly."
        }
    ],
    "rating": {
        "google_places_id": "ChIJN1t_tDeuEmsRUsoyG83frY4"
    }
}

Clear Sandbox Data

Clear all test data from the sandbox environment:

About the Sandbox

What You Can Do

Test user creation with various parameters
Test booking creation with different scenarios
Test listing create, update, and show (POST/PATCH/GET) without writing to the database
See realistic API responses
Practice API integration without risk

Important Notes

No real data is created or stored
All responses are mock data
Test data expires after 1 hour
Use this to learn the API structure