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
Terms of Use

Alpha Only: This service is subject to change

This service is a work in progress. It is currently subject to change or removal without notice.

Portals: Listing Categories

The portal homepage is allowed to have multiple Portal Listing Categories, and this resource supplies configuration and information on what listings to display for these categories as well as which ones to display and the desired order.

 
  1. Supported Roles
  2. Available Services
    1. Listing Categories
    2. Listing Category
  3. Listing Category Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes Yes

More information about roles may be found here.

 

Available Services

Listing Categories

/<API Version>/portal/listingcategories

HTTP Method Description Conditional Notes
GET Returns the portal listing categories. 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:

 

GET Response

{
  "D": {
    "Success": true,
    "Results": [
      {
        "Category": "Active",
        "Label": "Active",
        "ResourceUri": "/v1/portal/listingcategories/Active",
        "ListingUri": "/v1/my/listings",
        "Filter": "MlsStatus Eq 'Active'",
        "Enabled": true
      },
      {
        "Category": "ActiveContingent",
        "Label": "Active Contingent",
        "ResourceUri": "/v1/portal/listingcategories/Active Contingent",
        "ListingUri": "/v1/my/listings",
        "Filter": "MlsStatus Eq 'UAC'",
        "Enabled": false
      },
      {
        "Category": "Pending",
        "Label": "Pending",
        "ResourceUri": "/v1/portal/listingcategories/Pending",
        "ListingUri": "/v1/my/listings",
        "Filter": "StandardStatus Eq 'Pending'",
        "Enabled": false
      },
      {
        "Category": "Sold30",
        "Label": "Recently Sold (within 30 days)",
        "ResourceUri": "/v1/portal/listingcategories/Recently Sold (within 30 days)",
        "ListingUri": "/v1/my/listings",
        "Filter": "CloseDate Gt days(-30)",
        "Enabled": false
      },
      {
        "Category": "OpenHouse7",
        "Label": "Upcoming Open Houses",
        "ResourceUri": "/v1/portal/listingcategories/Upcoming Open Houses",
        "ListingUri": "/v1/my/listings",
        "Filter": "OpenHouse Bt now(),days(7)",
        "Enabled": false
      }
    ]
  }
}
 
 

Listing Category

/<API Version>/portal/listingcategories/<Category>

HTTP Method Description Conditional Notes
GET Returns a single portal listing category. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Enable a single portal listing category. Categories that support configuration may have the default Value modified here too. No
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
  "D": {
    "Success": true,
    "Results": [
      {
        "Category": "Active",
        "Label": "Active",
        "ResourceUri": "/v1/portal/listingcategories/Active",
        "ListingUri": "/v1/my/listings",
        "Filter": "MlsStatus Eq 'Active'",
        "Enabled": false
      }
    ]
  }
}
 

PUT Request

Request body:

{
  "D": {
    "Enabled": true
  }
}
 

PUT Response

The standard success/fail response is returned.

 
 

Listing Category Description

Attribute Data Type Writeable Required Description
Category Character The identifier for the portal listing category.
Label Character The name of the portal listing categorye.
ResourceUri Character The URI to the portal listing category.
ListingUri Character The listings service to use when requestings listings in this category.
Filter Character The search filter to apply for this category. Using this filter in conjunction with the ListingUri provides the listing results for this category.
Enabled Boolean Yes Enables the listing category on the portals home page.
Value Decimal Yes This attribute allows the user to customize a configurable category from a default setting. Only categories with a non null default are configurable. Applying a Value to a category that supports it will enable the category automatically.
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.