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
Terms of Use

Contacts: Export

The export sub-service allows a set of all contacts under control of the current account to be exported based on the time the resources were last modified.

  1. Supported Roles
  2. Available Services
    1. Full export
    2. Export Own Contacts
  3. Contact Description
  4. Expansions
  5. API Explorer
 

Supported Roles

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

More information about roles may be found here.

 

Available Services

Full export

/<API Version>/contacts/export/all

HTTP Method Description Notes
GET Returns a list of all contacts belonging to the current user, and all users under the current user's control  
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

Parameter Required
Standard search and paging syntax false

GET Response

{
    "D": {
        "Success": true,
        "ExportTimestamp": 2012-02-17T13:47:23
        "Results": [
            {
                "ResourceUri": "/vX/contacts/201010122342756895000000",
                "Id": "201010122342756895000000",
                "OwnerId": "201010943697015434000000",
                "DisplayName": "Some Person",
                "PrimaryEmail": "test@test.com",
                "Tags": [
                    "IDX Lead"
                ]
            },
            {
                "ResourceUri": "/vX/contacts/201010122342756234000000",
                "Id": "201010122342756234000000",
                "OwnerId": "201010123059764234000000",
                "DisplayName": "Another Person",
                "PrimaryEmail": "tester@testing.com",
                "Tags": [
                    "Recent Buyers"
                ]
            },
            
        ]
    }
}
 

Export Own Contacts

/<API Version>/contacts/export

HTTP Method Description Notes
GET Returns a list of all contacts belonging to the current user  
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

Parameter Required Notes
Standard search and paging syntax false  
_limit false The _limit parameter in this instance can bypass the maximum of 25 and be increased to 100

GET Response

{
    "D": {
        "Success": true,
        "ExportTimestamp": 2012-02-17T13:47:23
        "Results": [
            {
                "ResourceUri": "/vX/contacts/201010122342756895000000",
                "Id": "201010122342756895000000",
                "DisplayName": "Some Person",
                "PrimaryEmail": "test@test.com",
                "Tags": [
                    "IDX Lead"
                ]
            },
            {
                "ResourceUri": "/vX/contacts/201010122342756234000000",
                "Id": "201010122342756234000000",
                "DisplayName": "Another Person",
                "PrimaryEmail": "tester@testing.com",
                "Tags": [
                    "Recent Buyers"
                ]
            },
            
        ]
    }
}
 

Contact Description

See the response description for the Contacts service.

 

Expansions

None.

 

API Explorer

The API Explorer does not currently support this service.