Developer Documentation
Platform Overview
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: Mapping Layers Flexmls: Mapping Shapegen 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: Floor Plans 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: Floor Plans 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 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 Overlays Overlays: Shapes Portals Preferences 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
Supporting Documentation
Terms of Use

Floplan API - Examples

Here is a list of example requests that can be executed using curl at the command line. This is intended to provide a quick medium to access and examine floorplan data once you've been provided a FloPlan API access token. Note that in each example you'll need to replace the "ACCESS_TOKEN_HERE", "LISTINGKEY_HERE" and "RESO_OUID_HERE" indicators with your appropriate access token, ListingKey (see service documentation), and RESO OUID respectively.

Note that when using curl at the command line URL encoding or escaping may be necessary to ensure your request is parsed properly. This is demonstrated in the "with URL encoding..." example below.


Metadata retrieval (note the Accept header must be set to XML):

curl "$metadata" -H "Authorization: Bearer ACCESS_TOKEN_HERE" -H "Accept: application/xml"

Simple floorplan retrieval (parameters and information):

Request Format:

curl "$filter=OriginatingSystemResourceRecordKey eq 'LISTINGKEY_HERE' and OriginatingSystemResourceRecordSystemID eq 'RESO_OUID_HERE'" -H "Authorization: Bearer ACCESS_TOKEN_HERE" -H "Accept: application/json"

With dummy ListingKey and RESO OUID populated:

curl "$filter=OriginatingSystemResourceRecordKey eq '20200813172634864487000000' and OriginatingSystemResourceRecordSystemID eq 'T0151235'" -H "Authorization: Bearer ACCESS_TOKEN_HERE" -H "Accept: application/json"

With URL encoding, dummy ListingKey, and RESO OUID populated:

curl "" -H "Authorization: Bearer ACCESS_TOKEN_HERE" -H "Accept: application/json"


Floorplan retrieval specifying a maximum of one floorplan returned

curl "$filter=OriginatingSystemResourceRecordSystemID eq 'RESO_OUID_HERE'&$top=1" -H "Authorization: Bearer ACCESS_TOKEN_HERE" -H "Accept: application/json"

Floorplan retrieval specifying that records 16-20 should be retrieved (to page through the results)

curl "$filter=OriginatingSystemResourceRecordSystemID eq 'RESO_OUID_HERE'&$top=5&$skip=15" -H "Authorization: Bearer ACCESS_TOKEN_HERE" -H "Accept: application/json"