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: 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: 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: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata 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

Contact Tags

  1. Supported Roles
  2. Available Services
    1. All Tags
    2. Individual Tags
  3. Tag Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes Yes
Public Yes No
VOW Yes No
Portal Yes No
Private Yes Yes

More information about roles may be found here.

 

Available Services

All Tags

/<API Version>/contacts/tags

HTTP Method Description Notes
GET Returns a list of all tags for the current user  
POST Creates a new tag
PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

No parameters

GET Response

Example:

{
    "D": {
        "Success": true,
        "Results": [{
            "ResourceUri": "/v1/contacts/tags/IDX Lead",
            "Tag": "IDX Lead"
        },
        {
            "ResourceUri": "/v1/contacts/tags/Active Buyers",
            "Tag": "Active Buyers"
        }]
    }
}
 

POST Request

Request Body

{
    "D": {
        "Tag": "A New Tag"
    }
}
 

POST Response

The standard success/fail response is returned.

Individual Tags

/<API Version>/contacts/tags/<Tag>

HTTP Method Description Notes
GET Returns all contacts for the specified tag See the related documentation on escaping reserved characters in URLs
POST,PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Destroy an existing tag.

Get Request

Parameters:

 

GET Response

Example:

{
    "D": {
        "Success": true,
        "Results": [{
            "ResourceUri": "/vX/contacts/201010122342756895000000",
            "Id": "201010122342756895000000",
            "DisplayName": "Some Person",
            "PrimaryEmail": "test@test.com",
            "Tags": ["IDX Lead"]
        }, {
            "ResourceUri": "/vX/contacts/201010126342351895000000",
            "Id": "201010126342351895000000",
            "DisplayName": "Another Contact",
            "PrimaryEmail": "me@contact.com",
            "Tags": ["IDX Lead", "Active Buyers]
        }]
    }
}
 

Delete Request

Parameters:

 

DELETE Response

The standard success/fail response is returned.

 

Contact Tags Description

Attribute Data Type Writeable Required Description
ResourceUri Character No No The URI to the Tag
Tag Character Yes Yes The Contact Tag name. Maximum 75 characters.
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.