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: Required Documents 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: 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: Required Documents 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: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Overlays Overlays: Geometries Portals Portals: Listing Categories Portals: Metadata 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

RESO: Lookup

The Lookup service lists all possible values for fields which have a discrete list of defined values.

  1. Supported Roles
  2. Available Services
    1. Lookup field values
  3. Lookup Description
  4. Usage Notes
  5. Expansions

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

Lookup field values


HTTP Method Description Conditional Notes
GET Returns the list of possible values for a given field. 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



GET Response

    "@odata.context": "$metadata#Lookup",
    "@odata.nextLink": "",
    "value": [
            "LookupName": "MemberLanguages",
            "LookupValue": "Irish (Gaelic)",
            "StandardLookupValue": "Irish (Gaelic)",
            "LegacyODataValue": "Irish",
            "ModificationTimestamp": "2021-06-03T17:43:35Z",
            "LookupKey": "2027-2027-2614-97",
            "": "'2027-2027-2614-97')"
            "LookupName": "MemberType",
            "LookupValue": "Association Staff",
            "StandardLookupValue": "Association Staff",
            "LegacyODataValue": "b__3h43te5sge4whybhaatcaa",
            "ModificationTimestamp": "2021-06-07T17:30:11Z",
            "LookupKey": "2051-2051-2743-98",
            "": "'2051-2051-2743-98')"

Lookup Description

Attribute Data Type Searchable Description
LookupName Character Yes The name of the RESO Web API field to which the lookup value belongs.
LookupValue Character Yes The field value that will appear in the RESO Web API payload. This will replace the LegacyODataValue.
StandardLookupValue Character Yes The corresponding RESO Data Dictionary term, when applicable.
LegacyODataValue Character Yes The value currently delivered in the RESO Web API payload, including encoded b__ lookup values.
ModificationTimestamp Datetime Yes The time and date when the field value was last modified.
LookupKey Character No The unique system key for the field value.

Usage Notes