Contacts

  1. Supported Roles
  2. Available Services
    1. Contacts
    2. Individual Contacts
    3. Current User's Account
  3. Contact Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes Yes
VOW Yes No
Private Yes Yes
More information about roles may be found here.
VOW Role Support
Please note that VOW role reads are limited solely to the /my/contact resource.

Available Services

Additional Sub-Resources
Under a private role, you can manage a VOW user's saved searches and listing carts. See the corresponding documentation pages for additional resource information.

Contacts

URI: /<API Version>/contacts

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

GET Request

Parameters: 
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/contacts/201010122342756895000000",
                "Id": "201010122342756895000000",
                "DisplayName": "Some Person",
                "PrimaryEmail": "test@test.com",
                "Tags": [
                    "IDX Lead"
                ]
            }
        ]
    }
}

Individual Contact

URI: /<API Version>/contacts/<Id>

HTTP Method Description Notes
GET Retrieve contact information for a single contact
POST Returns HTTP 405 (Method Not Allowed) Not Implemented
PUT Updates the specified contact
DELETE Deletes the specified contact

GET Request

Parameters:

GET Response

See the GET response section above for the data format.

PUT Request

Request body: 
{
    "D": {
        "PrimaryPhoneNumber": "555-555-5555",
        "ReferredBy": "Mr. Crowley"
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Current User's Account

URI: /<API Version>/my/contact

HTTP Method Description Notes
GET Retrieve contact information for a single contact
POST, PUT, DELETE Returns HTTP 405 (Method Not Allowed) Not Implemented

GET Request

Parameters:
Parameter Required
Standard expansion parameters No

GET Response

See the GET response section above for the data format.

Contacts Description

Attribute Data Type Writeable? Required? Searchable? Description
ResourceUri Character No No No The URI to the particular contact.
Id Character No No No The unique id for the contact.
DisplayName Character Yes Yes Yes Maximum of 75 characters.
PrimaryEmail Character Yes Yes Yes Maximum of 75 characters.
SecondaryEmails Character List Yes No No
GivenName Character Yes No Yes Maximum of 300 characters.
MiddleName Character Yes No Yes Maximum of 300 characters.
FamilyName Character Yes No Yes Maximum of 300 characters.
SpouseGivenName Character Yes No Yes Maximum of 300 characters.
SpouseMiddleName Character Yes No Yes Maximum of 300 characters.
SpouseFamilyName Character Yes No Yes Maximum of 300 characters.
PrimaryPhoneNumber Character Yes No Yes Maximum of 300 characters.
HomePhoneNumber Character Yes No Yes Maximum of 300 characters.
WorkPhoneNumber Character Yes No Yes Maximum of 300 characters.
FaxPhoneNumber Character Yes No Yes Maximum of 300 characters.
MobilePhoneNumber Character Yes No Yes Maximum of 300 characters.
PagerPhoneNumber Character Yes No Yes Maximum of 300 characters.
OtherPhoneNumber Character Yes No Yes Maximum of 300 characters.
HomeStreetAddress Character Yes No Yes Maximum of 300 characters.
HomeLocality Character Yes No Yes Maximum of 300 characters.
HomeRegion Character Yes No Yes Maximum of 300 characters.
HomePostalCode Character Yes No Yes Maximum of 300 characters.
WorkStreetAddress Character Yes No Yes Maximum of 300 characters.
WorkLocality Character Yes No Yes Maximum of 300 characters.
WorkRegion Character Yes No Yes Maximum of 300 characters.
WorkPostalCode Character Yes No Yes Maximum of 300 characters.
Organization Character Yes No Yes Maximum of 300 characters.
Position Character Yes No Yes Maximum of 300 characters.
Birthday Character Yes No Yes Maximum of 300 characters.
Anniversary Character Yes No Yes Maximum of 300 characters.
Assistant Character Yes No Yes Maximum of 300 characters.
Children Character Yes No Yes Maximum of 300 characters.
Status Character Yes No Yes Maximum of 300 characters.
Other Character Yes No Yes Maximum of 300 characters.
Pets Character Yes No Yes Maximum of 300 characters.
ReferredBy Character Yes No Yes Maximum of 300 characters.
Salutation Character Yes No Yes Maximum of 300 characters.
Tags Character List Yes No Yes An array of tags associated with the contact. Each tag can be no longer than 75 characters.
Notify Boolean No Yes No Defaults to false. If present on a POST request, a message will be generated for the current user notifying them that a lead has been generated.
Settings.Active Boolean Yes No Yes Defaults to true. If false, the contact's VOW account (if it exists) will also be disabled.
Settings.ReverseProspecting Boolean Yes No No Defaults to false. If true, the contact will be present in reverse prospecting reports (support restricted to MLSs using flexmls Web).
Note Character Yes No No Maximum of 10,000 characters
Searching by DisplayName
When a wildcard is used on the account DisplayName attribute and no whitespace is present in the search string, the string will be applied to all words in the name, case-insensitive. Thus, if a contact's DisplayName is 'Neddy Nederlander', both _filter=DisplayName Eq 'Neddy*' and _filter=DisplayName Eq 'Neder*' will retrieve the contact.

Expansions

Expansion Roles Single Record Only? Description
Notes IDX, Private No Notes associated with the current contact.
VowEnabled IDX, Private No true if the contact has a VOW account that is also enabled.

API Explorer

Interact with this service using the API Explorer.