Developer Documentation
Platform Overview
Authentication
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics Messages News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
FloPlan
Terms of Use

Supplemental Authentication Services

For clients that implement their own authentication, there are supplemental authentication services to help auto-fill information when onboarding customers and identifying whether they have worked with an agent before or not.

The fields service is designed to accept the agent's portal name and return what attributes the agent's require to be filled in. This can also take an optional contact ID and provide auto-fill information in the options hash related to the forms. It also will indicate the type of input required by the browser (text, phone, tel, etc.)

 

Consumer Authentication Fields

/ticket/fields

HTTP Method Description Conditional Notes
GET Provides the signup and signup form requirements, which form to show, and pre-fill information based on identity. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

Parameter Required Notes
portal_slug Yes Name of Agent's Portal.
contact_id No If known, can be passed in to pre-fill any known values about the contact.
 
 

GET Response

{
  "D": {
    "Success": true,
    "Results": [{
      "default": "sign_up",
      "sign_up": [{
          "name": "username",
          "type": "email",
          "required": true,
          "options": {
            "value": "teddy_wong@mailinator.com"
          }
        }, {
          "name": "new_password",
          "type": "password",
          "required": true,
          "options": {}
        }, {
          "name": "confirm_password",
          "type": "password",
          "required": true,
          "options": {}
        }, {
          "name": "first_name",
          "type": "text",
          "required": true,
          "options": {
            "value": "Teddy"
          }
        }, {
          "name": "last_name",
          "type": "text",
          "required": true,
          "options": {
            "value": "Wong"
          }
        }, {
          "name": "phone",
          "type": "tel",
          "required": true,
          "options": {
            "value": "867-5309"
          }
        }, {
          "name": "city",
          "type": "text",
          "required": true,
          "options": {
            "value": "Hollywood"
          }
        }, {
          "name": "region",
          "type": "text",
          "required": true,
          "options": {
            "value": "CA"
          }
        }, {
          "name": "zip",
          "type": "text",
          "required": true,
          "options": {
            "value": "98201"
          }
        }, {
          "name": "street",
          "type": "text",
          "required": true,
          "options": {
            "value": "123 Super Fast Ct."
          }
        }],
      "sign_in": [{
          "name": "username",
          "type": "email",
          "required": true,
          "options": {
            "value": "teddy_wong@mailinator.com"
          }
        }, {
          "name": "password",
          "type": "password",
          "required": true,
          "options": {}
        }]
    }]
  }
}
 
 
 

Consumer Authentication Fields Description

Attribute Data Type Description
default Character Provides default form to be shown if signup and login not shown at same time.
sign_up Character Provides HTML attributes and autofill options for the sign-up form.
sign_in Character Provides HTML attributes and autofill options for the sign-in form.
 
 

Sign-In Form Description

Attribute Data Type Description
username Character Consumers email login. Uses 'email' HTML element attribute.
password Character Consumer login password. Uses 'password' HTML element attribute.
 
 

Sign-Up Form Description

Attribute Data Type Description
username Character Consumers email login. Options hash may contain value to pre-fill consumer information with. Uses 'email' HTML element attribute.
new_password Character Consumer login password. Uses 'password' HTML element attribute.
confirm_password Character Consumer login password. Uses 'password' HTML element attribute.
first_name Character Consumer's desired first name. Options hash may contain value to pre-fill consumer information with.
last_name Character Consumer's desired last name. Options hash may contain value to pre-fill consumer information with.
phone Character Consumer's desired phone number. Options hash may contain value to pre-fill consumer information with. Uses 'tel' HTML element attribute.
city Character Consumer's desired city. Options hash may contain value to pre-fill consumer information with.
region Character Consumer's desired state. Options hash may contain value to pre-fill consumer information with.
zip Character Consumer's desired zip code. Options hash may contain value to pre-fill consumer information with.
street Character Consumer's desired street address. Options hash may contain value to pre-fill consumer information with.