Back to top

Lead Channel

Overview

Resource Group

Get Open houses of a brand

Get Open houses of a brand
GET/brands/:brand/open-house-registration

brand (uuid) ID of the brand

Example URI

GET /brands/:brand/open-house-registration
URI Parameters
HideShow
brand
string (required) Example: 58ef11c1-67dc-480e-8531-0794dfea6e57
associations
string (required) Example: open_house_registration.listing,open_house_registration.template_instance
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "f561738b-7e39-46ca-827e-e813c986ebb3",
      "brand": "58ef11c1-67dc-480e-8531-0794dfea6e57",
      "template_instance": {
        "id": "cd82f31c-c077-473f-b208-20ea9e9eb5e4",
        "created_at": 1760470082.325061,
        "html": "SOME HTML",
        "file": {
          "id": "779b9752-ebcc-4275-a282-6e3a42612c3d",
          "created_at": 1760470085.136566,
          "updated_at": 1760470085.136566,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "templates/instances/e82042e0-a933-11f0-bdea-d5cf17ea076e.png",
          "name": "image.png",
          "public": true,
          "type": "file",
          "url": "https://test.cloudfront.net/templates/instances/e82042e0-a933-11f0-bdea-d5cf17ea076e.png",
          "preview_url": "https://test.cloudfront.net/templates/instances/e82042e0-a933-11f0-bdea-d5cf17ea076e.png",
          "mime": "image/png"
        },
        "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "branch": "http://mock-branch-url",
        "updated_at": 1760470082.325061,
        "deleted_at": null,
        "type": "template_instance"
      },
      "lead_channel": "926d170a-4e12-4451-9f0c-deef3dbdd277",
      "open_house": null,
      "listing": {
        "type": "listing",
        "id": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
        "property_id": "e88fac6a-f7ec-11e4-b318-0a95648eeb58",
        "created_at": 1431355770.035252,
        "updated_at": 1438634599.795186,
        "price": 498000,
        "matrix_unique_id": "52656456",
        "original_price": 519000,
        "last_price": 519000,
        "status": "Sold",
        "association_fee": null,
        "mls_number": "13103256",
        "association_fee_frequency": "",
        "association_fee_includes": "",
        "unexempt_taxes": null,
        "financing_proposed": "Cash,Conventional",
        "list_office_mui": "15514377",
        "list_office_mls_id": "WBSHRT01",
        "list_office_name": "Skylark Realtors",
        "list_office_phone": "(972) 965-6518",
        "possession": "Closing/Funding",
        "co_list_office_mui": "0",
        "co_list_office_mls_id": "",
        "co_list_office_name": "",
        "co_list_office_phone": "",
        "selling_office_mui": "15510668",
        "selling_office_mls_id": "PRGRP01",
        "selling_office_name": "Premier Group, REALTORS",
        "selling_office_phone": "(214) 944-4444",
        "co_selling_office_mui": "0",
        "co_selling_office_mls_id": "",
        "co_selling_office_name": "",
        "co_selling_office_phone": "",
        "list_agent_mui": "15555015",
        "list_agent_direct_work_phone": "(972) 965-6518",
        "list_agent_email": "[email protected]",
        "list_agent_full_name": "Anna K. Short",
        "list_agent_mls_id": "0534782",
        "co_list_agent_mui": "15515828",
        "co_list_agent_direct_work_phone": "(972) 212-9954",
        "co_list_agent_email": "",
        "co_list_agent_full_name": "William B. Short Jr.",
        "co_list_agent_mls_id": "0120894",
        "selling_agent_mui": "15525897",
        "selling_agent_direct_work_phone": "(214) 908-9008",
        "selling_agent_email": "[email protected]",
        "selling_agent_full_name": "Leeann Derdeyn",
        "selling_agent_mls_id": "0398378",
        "co_selling_agent_mui": "0",
        "co_selling_agent_direct_work_phone": "",
        "co_selling_agent_email": "",
        "co_selling_agent_full_name": "",
        "co_selling_agent_mls_id": "",
        "listing_agreement": "Exclusive Right to Sell/Lease",
        "mls_area_major": "DALLAS EAST (12)",
        "mls_area_minor": "EAST DALLAS (11)",
        "mls_name": "North Texas Real Estate Information Systems",
        "matrix_modified_dt": "2015-08-03T15:28:20.083Z",
        "showing_instructions_type": "Appointment (Appt Svc only),Centralized Showing Service",
        "tax_legal_description": "",
        "keybox_type": "Blue iBox",
        "keybox_number": "51950330",
        "close_date": 1431043200,
        "close_price": 478000,
        "deleted_at": null,
        "dom": null,
        "cdom": null,
        "buyers_agency_commission": "3%",
        "sub_agency_commission": "0%",
        "list_date": 1425189600,
        "showing_instructions": null,
        "appointment_phone": null,
        "appointment_phone_ext": null,
        "appointment_call": null,
        "occupancy": null,
        "private_remarks": null,
        "photos_checked_at": null,
        "application_fee_yn": null,
        "revision": null,
        "mls": "NTREIS",
        "transaction_type": "Unknown",
        "usage_type": "Unknown",
        "structure_type": "Unknown",
        "original_mls_property_type": null,
        "original_mls_property_subtype": null,
        "original_mls_status": null,
        "is_address_public": true,
        "parcel_number": null,
        "public_display": true,
        "annual_tax": null,
        "virtual_tour": null,
        "sub_agency_offered": null,
        "transaction_broker_commission": null,
        "compensation_based_on": null,
        "co_list_agent2_mui": null,
        "co_list_agent2_direct_work_phone": null,
        "co_list_agent2_email": null,
        "co_list_agent2_full_name": null,
        "co_list_agent2_mls_id": null,
        "co_list_agent3_mui": null,
        "co_list_agent3_direct_work_phone": null,
        "co_list_agent3_email": null,
        "co_list_agent3_full_name": null,
        "co_list_agent3_mls_id": null,
        "co_selling_agent2_mui": null,
        "co_selling_agent2_direct_work_phone": null,
        "co_selling_agent2_email": null,
        "co_selling_agent2_full_name": null,
        "co_selling_agent2_mls_id": null,
        "co_selling_agent3_mui": null,
        "co_selling_agent3_direct_work_phone": null,
        "co_selling_agent3_email": null,
        "co_selling_agent3_full_name": null,
        "co_selling_agent3_mls_id": null,
        "mls_display_name": "NTREIS",
        "list_agent": null,
        "favorited_in": null,
        "gallery_image_urls": [
          "http://cdn.rechat.co/52656495.jpg",
          "http://cdn.rechat.co/52656496.jpg",
          "http://cdn.rechat.co/52656497.jpg",
          "http://cdn.rechat.co/52656498.jpg",
          "http://cdn.rechat.co/52656499.jpg",
          "http://cdn.rechat.co/52656500.jpg",
          "http://cdn.rechat.co/52656501.jpg",
          "http://cdn.rechat.co/52656502.jpg",
          "http://cdn.rechat.co/52656503.jpg",
          "http://cdn.rechat.co/52656504.jpg",
          "http://cdn.rechat.co/52656505.jpg",
          "http://cdn.rechat.co/52656506.jpg",
          "http://cdn.rechat.co/52656507.jpg",
          "http://cdn.rechat.co/52656508.jpg",
          "http://cdn.rechat.co/52656509.jpg",
          "http://cdn.rechat.co/52656510.jpg",
          "http://cdn.rechat.co/52656511.jpg",
          "http://cdn.rechat.co/52656512.jpg",
          "http://cdn.rechat.co/52656513.jpg",
          "http://cdn.rechat.co/52656514.jpg",
          "http://cdn.rechat.co/52656515.jpg",
          "http://cdn.rechat.co/52656516.jpg",
          "http://cdn.rechat.co/52656517.jpg",
          "http://cdn.rechat.co/52656518.jpg",
          "http://cdn.rechat.co/52656519.jpg"
        ],
        "open_houses": null,
        "property": {
          "type": "property",
          "id": "e88fac6a-f7ec-11e4-b318-0a95648eeb58",
          "bedroom_count": 3,
          "bathroom_count": 2.1,
          "address_id": "e8207750-f7ec-11e4-b937-0a95648eeb58",
          "description": "Built in 1911 for physician, David L. Bettison, this stately Prairie home is an impeccable example of the arts and crafts style and movement.  Featured on the 2013 Munger Place Home Tour, this intricately restored home boasts a gorgeous kitchen, unusual patterned and inlaid maple floors, richly stained woodwork, an enormous master suite, a charming sleeping porch, three fully updated and modernized bathrooms, and large, landscaped yard.",
          "square_meters": 239.40914158305463,
          "created_at": 1431355761.401436,
          "updated_at": 1438634599.45139,
          "matrix_unique_id": 52656456,
          "property_type": "Residential",
          "property_subtype": "RES-Single Family",
          "lot_square_meters": 0,
          "year_built": null,
          "exterior_features": [
            "Balcony",
            "Covered Deck",
            "Covered Porch(es)",
            "Gutters",
            "Patio Covered",
            "Sprinkler System"
          ],
          "interior_features": [
            "Cable TV Available",
            "Decorative Lighting",
            "Dry Bar",
            "High Speed Internet Available"
          ],
          "fireplace_features": [
            "Brick",
            "Gas Logs"
          ],
          "lot_features": [
            "Interior Lot",
            "Landscaped",
            "Lrg. Backyard Grass"
          ],
          "parking_features": [
            "Front"
          ],
          "pool_features": [],
          "security_features": [
            "Burglar",
            "Carbon Monoxide Detector",
            "Fire/Smoke",
            "Monitored"
          ],
          "parking_spaces_covered_total": 0,
          "half_bathroom_count": 1,
          "full_bathroom_count": 2,
          "heating": [
            "Central Air-Elec",
            "Central Heat-Gas",
            "Zoned"
          ],
          "flooring": [
            "Ceramic Tile",
            "Stone",
            "Wood"
          ],
          "utilities": [
            "Alley",
            "City Sewer",
            "City Water",
            "Concrete",
            "Curbs",
            "Individual Gas Meter",
            "Individual Water Meter"
          ],
          "utilities_other": [],
          "architectural_style": [
            "Prairie"
          ],
          "number_of_stories": 2,
          "number_of_parking_spaces": 0,
          "garage_length": 0,
          "garage_width": 0,
          "number_of_dining_areas": 2,
          "number_of_living_areas": 3,
          "fireplaces_total": 1,
          "lot_number": "14",
          "soil_type": "",
          "construction_materials": "Siding,Wood",
          "foundation_details": "Pier & Beam",
          "roof": "Composition",
          "pool_yn": false,
          "handicap_yn": false,
          "elementary_school_name": "Lipscomb",
          "intermediate_school_name": "",
          "high_school_name": null,
          "junior_high_school_name": "",
          "middle_school_name": "Long",
          "primary_school_name": "",
          "senior_high_school_name": "",
          "school_district": "Dallas ISD",
          "subdivision_name": "Munger Place",
          "appliances_yn": null,
          "green_building_certification": "",
          "green_energy_efficient": "Low Flow Fixtures,Rain / Freeze Sensors",
          "lot_size": 0,
          "lot_size_area": 0,
          "lot_size_dimensions": "56X122",
          "number_of_pets_allowed": null,
          "number_of_units": 0,
          "pets_yn": null,
          "deleted_at": null,
          "furnished_yn": null,
          "fenced_yard_yn": null,
          "block": null,
          "mls": "NTREIS",
          "pets_policy": null,
          "amenities": null,
          "appliances": null,
          "fencing": null,
          "furnished": null,
          "lot_size_area_unit": "Acres",
          "building_area_total": null,
          "basement_bedroom_count": null,
          "address": {
            "title": "",
            "subtitle": "",
            "street_number": "5020",
            "street_name": "Junius",
            "city": "Dallas",
            "state": "Texas",
            "state_code": "TX",
            "postal_code": "75214",
            "neighborhood": "",
            "id": "e8207750-f7ec-11e4-b937-0a95648eeb58",
            "street_suffix": "Street",
            "unit_number": "",
            "country": "United States",
            "country_code": "USA",
            "created_at": 1431355760.671007,
            "updated_at": 1438634599.212481,
            "location_google": {
              "type": "Point",
              "crs": {
                "type": "name",
                "properties": {
                  "name": "EPSG:4326"
                }
              },
              "coordinates": [
                -96.765508,
                32.801221
              ]
            },
            "matrix_unique_id": 52656456,
            "geocoded": null,
            "geo_source": "None",
            "partial_match_google": null,
            "county_or_parish": "Dallas",
            "direction": null,
            "street_dir_prefix": "",
            "street_dir_suffix": "",
            "street_number_searchable": "5020",
            "geo_source_formatted_address_google": "5020 Junius Street, Dallas, TX 75214, USA",
            "geocoded_google": true,
            "geocoded_bing": false,
            "location_bing": null,
            "geo_source_formatted_address_bing": null,
            "geo_confidence_google": null,
            "geo_confidence_bing": null,
            "location": null,
            "approximate": null,
            "corrupted": null,
            "corrupted_google": false,
            "corrupted_bing": null,
            "deleted_at": null,
            "mls": "NTREIS",
            "location_mapbox": null,
            "geocoded_mapbox": null,
            "corrupted_mapbox": null,
            "geo_source_formatted_address_mapbox": null,
            "geo_confidence_mapbox": null,
            "type": "address",
            "full_address": "5020 Junius Street Dallas, TX 75214",
            "street_address": "5020 Junius Street"
          }
        },
        "user_listing_notification_setting": null,
        "cover_image_url": "http://cdn.rechat.co/52656495.jpg",
        "_url": "https://irish.rechat.com/dashboard/mls/edb5195a-f7ec-11e4-bc76-0a95648eeb58",
        "formatted": {
          "type": "formatted_listing",
          "price": {
            "type": "formatted_attribute",
            "text": "$478,000",
            "text_no_label": "478,000",
            "value": 478000
          },
          "original_price": {
            "type": "formatted_attribute",
            "text": "$498,000",
            "text_no_label": "498,000",
            "value": 498000
          },
          "square_feet": {
            "type": "formatted_attribute",
            "text": "2,577 SQFT",
            "text_no_label": "2,577",
            "value": 2577
          },
          "lot_size_square_feet": {
            "type": "formatted_attribute",
            "text": "0 SQFT",
            "text_no_label": "0",
            "value": 0
          },
          "lot_size_acres": {
            "type": "formatted_attribute",
            "text": "0 Acres",
            "text_no_label": "0",
            "value": 0
          },
          "lot_size_area": {
            "type": "formatted_attribute",
            "text": "0 SQFT",
            "text_no_label": "0",
            "value": 0
          },
          "building_area_total": {
            "type": "formatted_attribute",
            "text": null,
            "text_no_label": null,
            "value": null
          },
          "bedroom_count": {
            "type": "formatted_attribute",
            "text": "3 Bedrooms",
            "text_no_label": "3",
            "value": 3
          },
          "basement_bedroom_count": {
            "type": "formatted_attribute",
            "text": null,
            "text_no_label": null,
            "value": null
          },
          "bathrooms": {
            "type": "formatted_attribute",
            "text": "2.1 Bathrooms",
            "text_no_label": "2.1",
            "value": "2.1"
          },
          "total_bathroom_count": {
            "type": "formatted_attribute",
            "text": "3 Bathrooms",
            "text_no_label": "3",
            "value": "3"
          },
          "parking_spaces": {
            "type": "formatted_attribute",
            "text": "0 Parking Spaces",
            "text_no_label": "0",
            "value": 0
          },
          "street_address": {
            "type": "formatted_attribute",
            "text": "5020 Junius Street",
            "text_no_label": "5020 Junius Street",
            "value": "5020 Junius Street"
          },
          "full_address": {
            "type": "formatted_attribute",
            "text": "5020 Junius Street Dallas, TX 75214",
            "text_no_label": "5020 Junius Street Dallas, TX 75214",
            "value": "5020 Junius Street Dallas, TX 75214"
          },
          "address_line_2": {
            "type": "formatted_attribute",
            "text": "Dallas, TX 75214",
            "text_no_label": "Dallas, TX 75214",
            "value": "Dallas, TX 75214"
          },
          "region": {
            "type": "formatted_attribute",
            "text": "Texas",
            "text_no_label": "Texas",
            "value": "Texas"
          },
          "city_and_region": {
            "type": "formatted_attribute",
            "text": "Dallas, Texas",
            "text_no_label": "Dallas, Texas",
            "value": "Dallas, Texas"
          },
          "listed_by": {
            "type": "formatted_attribute",
            "text": "Listed by: Anna K. Short | Skylark Realtors",
            "text_no_label": "Anna K. Short | Skylark Realtors",
            "value": "Anna K. Short | Skylark Realtors"
          },
          "listed_by_email": {
            "type": "formatted_attribute",
            "text": "[email protected]",
            "text_no_label": "[email protected]",
            "value": "[email protected]"
          },
          "listed_by_phone": {
            "type": "formatted_attribute",
            "text": "(972) 965-6518",
            "text_no_label": "(972) 965-6518",
            "value": "(972) 965-6518"
          },
          "unexempt_taxes": {
            "type": "formatted_attribute",
            "text": null,
            "text_no_label": null,
            "value": null
          }
        }
      },
      "tz": "US/Eastern",
      "title": "test",
      "deal": null,
      "type": "open_house_registration",
      "created_at": 1760470085.217698,
      "updated_at": 1760470085.2177,
      "deleted_at": null,
      "start_time": 1760470085.191,
      "end_time": 1760473685.191,
      "notification_sent_at": null,
      "lead_count": "0",
      "url": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3/register",
      "qr_code": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3.png"
    }
  ],
  "info": {
    "count": 1,
    "total": 1
  }
}

Get Open house HTML. this endpoint is public and return the HTML

Get Open house HTML. this endpoint is public and return the HTML
GET/open-house-registration/:id/register

id (uuid) ID of open house

Example URI

GET /open-house-registration/:id/register
URI Parameters
HideShow
id
string (required) Example: f561738b-7e39-46ca-827e-e813c986ebb3
Response  200
HideShow
Body
SOME HTML

Get Open house QR code. this endpoint is public

Get Open house QR code. this endpoint is public
GET/open-house-registration/:id.png

id (uuid) ID of open house

Example URI

GET /open-house-registration/:id.png
URI Parameters
HideShow
id
string (required) Example: f561738b-7e39-46ca-827e-e813c986ebb3
Response  200

Get Open house by id

Get Open house by id
GET/brands/:brand/open-house-registration/:id

id (uuid) ID of open house

Example URI

GET /brands/:brand/open-house-registration/:id
URI Parameters
HideShow
brand
string (required) Example: 58ef11c1-67dc-480e-8531-0794dfea6e57
id
string (required) Example: f561738b-7e39-46ca-827e-e813c986ebb3
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "f561738b-7e39-46ca-827e-e813c986ebb3",
    "brand": "58ef11c1-67dc-480e-8531-0794dfea6e57",
    "lead_channel": "926d170a-4e12-4451-9f0c-deef3dbdd277",
    "open_house": null,
    "tz": "US/Eastern",
    "title": "test",
    "deal": null,
    "type": "open_house_registration",
    "created_at": 1760470085.217698,
    "updated_at": 1760470085.381073,
    "deleted_at": null,
    "start_time": 1760470085.359,
    "end_time": 1760473685.359,
    "notification_sent_at": null,
    "lead_count": "0",
    "url": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3/register",
    "qr_code": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3.png"
  }
}

Create a open house registration

Create a open house registration
POST/brands/:brand/open-house-registration

Example URI

POST /brands/:brand/open-house-registration
URI Parameters
HideShow
brand
string (required) Example: 58ef11c1-67dc-480e-8531-0794dfea6e57
Request
HideShow
Body
{
  "template_instance": "cd82f31c-c077-473f-b208-20ea9e9eb5e4",
  "lead_channel": "926d170a-4e12-4451-9f0c-deef3dbdd277",
  "start_time": 1760470085.191,
  "end_time": 1760473685.191,
  "tz": "US/Eastern",
  "listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
  "title": "test"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "f561738b-7e39-46ca-827e-e813c986ebb3",
    "brand": "58ef11c1-67dc-480e-8531-0794dfea6e57",
    "lead_channel": "926d170a-4e12-4451-9f0c-deef3dbdd277",
    "open_house": null,
    "tz": "US/Eastern",
    "title": "test",
    "deal": null,
    "type": "open_house_registration",
    "created_at": 1760470085.217698,
    "updated_at": 1760470085.2177,
    "deleted_at": null,
    "start_time": 1760470085.191,
    "end_time": 1760473685.191,
    "notification_sent_at": null,
    "lead_count": "0",
    "url": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3/register",
    "qr_code": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3.png"
  }
}

Update open house registration

Update open house registration
PUT/brands/:brand/open-house-registration/:id

Example URI

PUT /brands/:brand/open-house-registration/:id
URI Parameters
HideShow
brand
string (required) Example: 58ef11c1-67dc-480e-8531-0794dfea6e57
id
string (required) Example: f561738b-7e39-46ca-827e-e813c986ebb3
Request
HideShow
Body
{
  "template_instance": "cd82f31c-c077-473f-b208-20ea9e9eb5e4",
  "lead_channel": "926d170a-4e12-4451-9f0c-deef3dbdd277",
  "start_time": 1760470085.359,
  "end_time": 1760473685.359,
  "tz": "US/Eastern",
  "listing": "edb5195a-f7ec-11e4-bc76-0a95648eeb58",
  "title": "test"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "f561738b-7e39-46ca-827e-e813c986ebb3",
    "brand": "58ef11c1-67dc-480e-8531-0794dfea6e57",
    "lead_channel": "926d170a-4e12-4451-9f0c-deef3dbdd277",
    "open_house": null,
    "tz": "US/Eastern",
    "title": "test",
    "deal": null,
    "type": "open_house_registration",
    "created_at": 1760470085.217698,
    "updated_at": 1760470085.381073,
    "deleted_at": null,
    "start_time": 1760470085.359,
    "end_time": 1760473685.359,
    "notification_sent_at": null,
    "lead_count": "0",
    "url": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3/register",
    "qr_code": "http://localhost:3079/open-house-registration/f561738b-7e39-46ca-827e-e813c986ebb3.png"
  }
}

Delete a Open house registrations

Delete a Open house registrations
DELETE/brands/:brand/open-house-registration/:id

Example URI

DELETE /brands/:brand/open-house-registration/:id
URI Parameters
HideShow
brand
string (required) Example: 58ef11c1-67dc-480e-8531-0794dfea6e57
id
string (required) Example: f561738b-7e39-46ca-827e-e813c986ebb3
Response  204

Generated by aglio on 14 Oct 2025