Accounts

The Accounts service provides access to user settings and profile information.

  1. Supported Roles
  2. Available Services
    1. All Accounts
    2. Individual Account
    3. Accounts for Office Members
    4. Current User's Account
  3. Accounts Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes No
VOW Yes Yes
Private Yes No
More information about roles may be found here.

Available Services

All Accounts

URI: /<API Version>/accounts

HTTP Method Description Notes
GET Returns account info for the matching user(s)
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

GET Response

See the GET request section for for the accounts service.

Individual Account

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

HTTP Method Description Notes
GET Returns account info for the matching user
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the accounts service.

Accounts for Office Members

URI: /<API Version>/accounts/by/office/<Id>

HTTP Method Description Notes
GET Returns all users in the matching office
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the accounts service.

Current User's Account

URI: /<API Version>/my/account

HTTP Method Description Notes
GET Returns account info for the current user
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Modifies user settings VOW roles only
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
Parameter Required
Standard expansion parameters No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/v1/accounts/20000426143505724621000000",
                "Name": "Sample User",
                "Id": "20000426173054342350000000",
                "UserType": "Office",
                "UserLevel": "Office",
                "Office": "Sample Office Inc",
                "OfficeId": "20030426173014239760000000",
                "Company": null,
                "CompanyId": null,
                "Mls": "Your Local MLS",
                "MlsId": "20000426143505724628000000",
                "Emails": [
                    {
                        "Id": "20030426173014239760000000",
                        "Type": "Work",
                        "Name": "My Work E-mail",
                        "Address": "work@test.com",
                        "Primary": true
                    },
                    {
                        "Id": "20030521173014276180000000",
                        "Type": "Mobile",
                        "Name": "My Mobile E-mail",
                        "Address": "mobile@test.com"
                    }
                ],
                "Phones": [
                    {
                        "Id": "20040426173010918520000000",
                        "Type": "Work",
                        "Name": "My Work Phone",
                        "Number": "701-555-1212",
                        "Primary": true
                    },
                    {
                        "Id": "20030426173017935470000000",
                        "Type": "Mobile",
                        "Name": "My Mobile Phone",
                        "Number": "702-555-1313"
                    }
                ],
                "Websites": [
                    {
                        "Id": "20080111173011632650000000",
                        "Type": "Work",
                        "Name": "My Work Website",
                        "Uri": "http://iamthebestagent.com",
                        "Primary": true
                    },
                    {
                        "Id": "20060412173019920160000000",
                        "Type": "Mobile",
                        "Name": "My Mobile Website",
                        "Uri": "http://m.iamthebestagent.com"
                    }
                ],
                "Addresses": [
                    {
                        "Id": "20090426173019195810000000",
                        "Type": "Work",
                        "Name": "My Work Address",
                        "Address": "101 Main Ave, Phoenix, AZ 12345",
                        "Primary": true
                    }
                ],
                "Images": [
                    {
                        "Id": "20110426173018175220000000",
                        "Type": "Photo",
                        "Name": "My Photo",
                        "Uri": "http://photos.sparkplatform.com/az/...."
                    },
                    {
                        "Id": "20080426173011752890000000",
                        "Type": "Logo",
                        "Name": "My Logo",
                        "Uri": "http://photos.sparkplatform.com/az/...."
                    }
                ],
                "Locale": {
                  "Language": "en"
                },
                "Permissions": {
                  "Editable": false,
                  "EditableSettings": [] 
                },
                "Settings": {
                    "Visible": true,
                    "SearchRestrictions": {
                        "MlsStatus": [
                            "A",
                            "P"
                        ],
                        "PostalCode": null
                    }
                }
            }
        ]
    }
}

PUT Request

Request body:
{
    "D": {
        "GetEmailUpdates": true
    }
}

PUT Response

The standard success/fail response is returned.

Account Description

Attribute Data Type Writeable? Required? Searchable? Description
ResourceId Character No No No The resource URI to a particular account.
Id Character No No No The unique id for the account.
UserType Character No No Yes, required The type of account. Possible values are Member, Office and Mls.
UserLevel Character No No No The user level of the account. Possible values include all values for UserType as well as Company and Association.
Office Character No No Yes The name of the office the user belongs to
OfficeId Character No No Yes The account id of the office the user belongs to
Company Character No No Yes The name of the company the user belongs to
CompanyId Character No No Yes The account id of the company the user belongs to.
Mls Character No No No The name of the MLS the user belongs to.
MlsId Character No No Yes The account id of the MLS the user belongs to.
Name Character No No Yes The full name of the user. See the notes below for more information on searching by name.
FirstName Character No No Yes The first name of the user.
MiddleName Character No No Yes The first name of the user.
LastName Character No No Yes The first name of the user.
Email Character No No Yes For searching only. References Email.Address.
Tags Character List No No Yes The tags associated with the account record. Consult accounts meta data for possible values.
Associations Character List No No Yes The associations the account record belongs to. Consult accounts meta data for possible values.
Permissions.Editable Boolean No No No true if the current user may edit the user record being retrieved.
Permissions.EditableSettings Character List No No No A list of editable actions the current user can take on the account record.Possible values: PasswordChange
Settings.SearchRestrictions. PostalCode Character List No No No An array of PostalCode values the user is limited to when searching listings. If null, the user has no restrictions.
Settings.SearchRestrictions. MlsStatus Character List No No No An array of MlsStatus values the user is limited to when searching listings. If null, the user has no restrictions.
Settings.Visible Boolean No No No If false, the user cannot be retrieved in accounts search results.
PostalCode Character No No Yes For searching only. References Address.PostalCode.
Profile Fields Various types No No No All account profile fields are also available from this service.
GetEmailUpdates Boolean VOW only Yes No VOW roles can only see and modify this field when using the /my/account service.
Searching by Name
When a wildcard is used on the account Name attribute and no whitespace is present in the search string, the string will be applied to all words in the name, case-insensitive. For example, _filter=UserType Eq 'Member' And (FirstName Eq 'thomas*' Or MiddleName Eq 'thomas*' Or LastName Eq 'thomas*') is (typically) equivalent to _filter=UserType Eq 'Member' And Name Eq 'thomas*'.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Permissions Private Yes No A hash detailing permissions the current user has on the user record being retrieved.
Settings All Yes No A hash of additional user settings, detailing restrictions such as searching limitiations.

API Explorer

Interact with this service using the API Explorer.