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: 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: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Portals 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

Privileged API Keys Only

Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

Flexmls: Listing Reports

Like all flexmls subservices, the data provided from this service is not fully supported by Spark API. This resource is meant to help application developers transition from legacy flexmls Web features to Spark API.

 
  1. Supported Roles
  2. Available Services
    1. All Flexmls Listing Reports
  3. Listing Reports 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 No

More information about roles may be found here.

 

Available Services

All Flexmls Listing Reports

/<API Version>/flexmls/listingreports

HTTP Method Description Conditional Notes
GET Returns a list of all listing reports in flexmls Web available to the current user. 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": [
          {
              "FlexmlsId": "s,fulllistA",
              "Name": "Standard"
          },
          {
              "FlexmlsId": "s,fulllistB",
              "Name": "Standard Style B"
          },
          {
              "FlexmlsId": "s,lp",
              "Name": "Details at the side, with photo"
          },
          {
              "FlexmlsId": "s,l",
              "Name": "Details at the side, no photo"
          },
          {
              "FlexmlsId": "s,lr",
              "Name": "Details at the side, no photo, profile info"
          },
          {
              "FlexmlsId": "s,lpr",
              "Name": "Details at the side, with photo, profile info"
          },
          {
              "FlexmlsId": "s,full",
              "Name": "Full Report"
          }
        ]
    }
}
 
 

Listing Reports Description

Attribute Data Type Description
FlexmlsId Character A unique identifier for the report. These IDs are non-standard to Spark, and are constructed in a way that allows legacy flexmls Web applications to decipher the type, and sub-type, of each report.
Name Character The human-presentable name of the report.
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.