Veco Plus API
    Veco Plus API
    • Introduction
    • Authentication
    • API Keys
    • Rate Limits
    • Data Types
    • Enums Reference Guide
    • Contacts
      • List all events
        GET
      • Get event by id
        GET
    • Properties
      • List all events
        GET
      • Get event by id
        GET
    • Schemas
      • Contact communication
      • Property payload
      • Property Address
      • Property Price Information
      • Property Media
      • Property Details
      • Property Sizing
      • Property Rooms
      • Property List Events Response
      • Property EPC Information
      • Property Obligations
      • Property Risks
      • ExternalOfficeReference
      • Contact List Events Response
      • Contact payload

    Property payload

    {
        "agent_ref": "aa91214f-30a8-44f9-b089-4feea95242bc",
        "published": true,
        "property_type": "Please see Enums Reference Guide (Property Type)",
        "status": "Please see Enums Reference Guide (Property Status)",
        "statusString": "string",
        "new_home": true,
        "student_property": true,
        "house_flat_share": true,
        "created_date": "string",
        "updated_date": "string",
        "date_available": "string",
        "contract_months": 0,
        "minimum_term": 0,
        "let_type": "Please see Enums Reference Guide (Let Type)",
        "address": {
            "house_name_number": "string",
            "address_2": "string",
            "address_3": "string",
            "address_4": "string",
            "town": "string",
            "postcode_1": "string",
            "postcode_2": "string",
            "display_address": "string",
            "latitude": 0,
            "longitude": 0
        },
        "price_information": {
            "price": 0,
            "price_qualifier": "Please see Enums Reference Guide (Price Qualifer)",
            "price_qualifier_string": "string",
            "deposit": 0,
            "administration_fee": "string",
            "rent_frequency": "Please see Enums Reference Guide (Rent Frequency)",
            "rent_frequency_string": "string",
            "tenure_type": "Please see Enums Reference Guide (Tenure Type)",
            "tenure_type_string": "string",
            "auction": true,
            "tenure_unexpired_years": 0,
            "price_per_unit_area": 0,
            "price_per_unit_per_annum": 0,
            "shared_ownership": true,
            "shared_ownership_percentage": 0,
            "shared_ownership_rent": 0,
            "shared_ownership_rent_frequency": "Please see Enums Reference Guide (Rent Frequency)",
            "shared_ownership_rent_frequency_string": "string",
            "annual_ground_rent": 0,
            "ground_rent_review_period_years": 0,
            "ground_rent_percentage_increase": 0,
            "annual_service_charge": 0,
            "holding_deposit": 0
        },
        "media": [
            {
                "media_type": "Please see Enums Reference Guide (Media Type)",
                "media_url": "http://example.com",
                "caption": "string",
                "sort_order": 0,
                "media_update_date": "string"
            }
        ],
        "details": {
            "summary": "string",
            "description": "string",
            "features": [
                "string"
            ],
            "bedrooms": 0,
            "bathrooms": 0,
            "reception_rooms": 0,
            "parking": [
                0
            ],
            "outside_space": [
                0
            ],
            "year_built": 0,
            "internal_area": 0,
            "internal_area_unit": 0,
            "land_area": 0,
            "land_area_unit": 0,
            "sizing": {
                "minimum": 0,
                "maximum": 0,
                "area_unit": 0
            },
            "floors": 0,
            "entrance_floor": 0,
            "condition": 0,
            "accessibility": [
                0
            ],
            "heating": [
                0
            ],
            "furnished_type": 0,
            "pets_allowed": true,
            "smokers_considered": true,
            "sharers_considered": true,
            "burglar_alarm": true,
            "washing_machine": true,
            "dishwasher": true,
            "all_bills_inc": true,
            "water_bill_inc": true,
            "gas_bill_inc": true,
            "electricity_bill_inc": true,
            "oil_bill_inc": true,
            "council_tax_inc": true,
            "council_tax_exempt": true,
            "tv_licence_inc": true,
            "sat_cable_tv_bill_inc": true,
            "internet_bill_inc": true,
            "business_for_sale": true,
            "comm_use_class": [
                0
            ],
            "council_tax_band": "string",
            "domestic_rates": 0,
            "rooms": [
                {
                    "room_name": "string",
                    "room_description": "string",
                    "room_length": 0,
                    "room_width": 0,
                    "room_dimension_unit": 0,
                    "room_dimension_text": "string",
                    "room_photo_urls": [
                        "http://example.com"
                    ]
                }
            ],
            "sewerage": "string",
            "water": "string",
            "broadband": [
                "string"
            ],
            "electricity": [
                "string"
            ],
            "obligations": {
                "listed": true,
                "restrictions": true,
                "requiredAccess": true,
                "rightOfWay": true
            },
            "epc_information": {
                "epc_certificate_id": "string",
                "current_energy_efficiency": 0,
                "potential_energy_efficiency": 0,
                "current_energy_rating": 0,
                "potential_energy_rating": 0
            },
            "deposit_replacement_scheme": true,
            "risks": {
                "sources_of_flooding": [
                    "string"
                ],
                "flood_defences": true
            }
        },
        "branch_id": "string",
        "directions": "string",
        "veco_reference": "string",
        "reference": "string",
        "ExternalOfficeReference": {
            "BrandId": "string",
            "Reference": "string",
            "Name": "string"
        }
    }
    Built with