Shared Links

The Shared Links service creates permalinks to a saved search or a group of one or more listings. The permalink is intended to be viewed by a web browser.

  1. Supported Roles
  2. Available Services
    1. Create a new Shared Link
    2. All Shared Links
    3. Individual Shared Link
  3. Shared Link Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX Yes Yes Writes for privileged keys only
Public Yes Yes Writes for privileged keys only
VOW Yes Yes
Portal Yes Yes
Private Yes Yes Only private roles may access the 'All Shared Links' resource.
More information about roles may be found here.

Available Services

Create Shared Link

/<API Version>/sharedlinks/(search|listings)

When sharing listings to one or more contacts (by specifying ContactIds) the supplied listings will automatically be added to their Recommended cart. While this will also add those listings to the RecommendedCart news feed for each contact, no notifications will be triggered for that feed.

HTTP Method Description Conditional Notes
GET Returns HTTP 405 (Method Not Allowed) No Not implemented
POST Create a new shared link No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

POST Request

Request body:
// POST /sharedlinks/listings
{
    "D": {
      "ListingIds": ["20100912153422758914000000", "20100912153422758914000001"]
    }
}

// POST /sharedlinks/search
{
    "D": {
      "SearchId": "20100912153422758914000000"
    }
}

POST Response

The standard success/fail response is returned.

All Shared Links

/<API Version>/sharedlinks

HTTP Method Description Conditional Notes
GET Returns all shared links accessible by the current user, ordered by creation time. 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
Pagination No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
            "Id": "15Ar",
            "ResourceUri": "/v1/sharedlistings/15Ar",
            "SharedUri": "http://www.flexmls.com/share/15Ar/3544-N-Olsen-Avenue-Filabee-AZ-85719",
            "Type": "Indirect",
            "Mode": "Idx",
            "ContactIds": [],
            "ListingIds": ["20110224152431857619000000"]
          }
        ]
    }
}

Individual Shared Link

/<API Version>/sharedlinks/<Id>

HTTP Method Description Conditional Notes
GET Returns information for a specific shared link 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:
  • None

GET Response

See the GET request section for for the shared links service.

Shared Link Description

Attribute Data Type Writeable Required Description
Id Character No No The unique id for the news feed.
ResourceUri Character No No The URI to the individual news feed resource.
SharedUri Character No No The permalink to the shared resource
Type Character Yes No Either Direct or Indirect (Indirect by default). Direct shares have a specific recipient, such as an agent sharing a listing via e-mail with a homebuyer. Indirect shared links are publicly shared with not specific recipient, such as posting a shared link to social media. Indirect shares may have additional restrictions based on MLS rules, while Direct shares will always have a Mode of Public, and can only be created by private roles.
Mode Character Yes No Indicates the mode in which the current listing(s) were shared. Possible values include Idx, Public and Vow. Vow role keys are set to a Public mode.
ContactIds Character List Private Roles Only No When specified, auto-adds all shared listings to the Recommended cart for each contact. Listings added to the Recommended cart only when Listings are shared.
SavedSearch JSON Object SearchId on creation only. No The SavedSearch referenced by this link (if applicable)
ListingIds Character Array ListingIds on creation only. No An array of listing IDs as returned by the Listings service (if applicable). 200 listings max.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Contacts Private No No Returns all contacts specified by the ContactIds record.