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: Geometries 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

Example: Setting Up VOW Accounts

Spark's VOW support allows consumers to log in to your portal to create their own searches. To make use of this feature, you must create both a portal and a VOW account for each contact you'd like to offer this service to.

  1. Authentication
  2. Create your portal
  3. Create a VOW account for an existing contact
  4. Retrieve your Portal Name for the URI
  5. Generate the URI to your portal's OAuth 2 endpoint

Step 1: Authentication

This example expects that you have already obtained an OAuth 2 authorization token to access a user's data. Read more on our OpendID Connect Authentication and OAuth 2 Authorization.


Step 2: Create your portal

If you do not yet have a portal created, create one by supplying a portal name or the Portal Creation service.

$ curl "" -H "Authorization: OAuth MY_OAUTH2_ACCESS_TOKEN"  -H 'Content-Type: application/json' -X POST --data '{ "D": { "DisplayName": "GreatPortal", "Enabled": true } }'
    "D": {
        "Success": true

Step 3: Create a VOW account for an existing contact

Once your portal is created, you'll need to attach a VOW account to a contact, if it doesn't have one already. To create one, send a LoginName and Password to the Contact Portal service.

$ curl "<Contact.Id>/portal" -H "Authorization: OAuth MY_OAUTH2_ACCESS_TOKEN"  -H 'Content-Type: application/json' -X POST --data '{ "D": { "LoginName": "Johnny Everyman", "Password": "MyPassw0rd" } }'
  "D": {
      "Success": true

Step 4: Retrieve your Portal Name for the URI

While you supplied a DisplayName for your portal in step two, you'll need to retrieve auto-generated Name attribute to assemble the authorization endpoint to send VOW users to. You'll notice that, while we provided the DisplayName GreatPortal, the system generated the name greatportal for us to use in the URI.

$ curl "" -H "Authorization: OAuth MY_OAUTH2_ACCESS_TOKEN"  
  "D": {
        "ResourceUri": "/v1/portal/20100912153422758914000000",
        "Id": "20100912153422758914000000",
        "OwnerId": "20110000000000000000000001",
        "ModificationTimestamp": 2011-11-18T16:35:43,
        "Name": "greatportal",
        "DisplayName": "GreatPortal",
        "Enabled": true,
        "RequiredFields": ["Address", "Phone"]

Step 5: Generate the URI to your portal's OAuth 2 endpoint

Using the portal name above, attach that to the OAuth 2 VOW Endpoint as follows:

From here, the consumer will begin the OAuth 2 flow.