Accounts

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

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

Supported Roles

Role Reads Writes Notes
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 Conditional Notes
GET Returns account info for the matching user(s) No
POST Creates a new account No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

GET Response

See the GET request section for for the accounts service.

POST Request

Request body:
{
   "D":{
      "Name":"Sample Office Inc",
      "UserType":"Office",
      "UserLevel":"Office",
      "Emails":[
         {
            "Type":"Work",
            "Name":"My Work E-mail",
            "Address":"work@test.com",
            "Primary":true
         },
         {
            "Type":"Mobile",
            "Name":"My Mobile E-mail",
            "Address":"mobile@test.com"
         }
      ],
      "Phones":[
         {
            "Type":"Work",
            "Name":"My Work Phone",
            "Number":"701-555-1212",
            "Primary":true
         },
         {
            "Type":"Mobile",
            "Name":"My Mobile Phone",
            "Number":"702-555-1313"
         }
      ],
      "Websites":[
         {
            "Type":"Work",
            "Name":"My Work Website",
            "Uri":"http://iamthebestagent.com",
            "Primary":true
         },
         {
            "Type":"Mobile",
            "Name":"My Mobile Website",
            "Uri":"http://m.iamthebestagent.com"
         }
      ],
      "Addresses":[
         {
            "Type":"Work",
            "Name":"My Work Address",
            "Address":"101 Main Ave, Phoenix, AZ 12345",
            "Primary":true
         }
      ]
   }
}

POST Response

The standard success/fail response is returned.

All Accounts for Reports

URI: /<API Version>/accounts/report

Similar to the All Accounts service, the report subservice provides a consistent presentation of data for all records, fit for display specifically on a listing report or a business card.

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

GET Request

Parameters:

GET Response

See the GET request section for for the accounts service.

All Accounts for Rosters

URI: /<API Version>/accounts/roster

Similar to the All Accounts service, the roster subservice provides a consistent presentation of data for all records, fit for display specifically on a member roster.

HTTP Method Description Conditional Notes
GET Returns account info for the matching user(s) No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No 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 Conditional Notes
GET Returns account info for the matching user No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the accounts service.

Individual Account for Reports

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

Similar to the All Accounts service, the report subservice provides a consistent presentation of data for all records, fit for display specifically on a listing report or a business card.

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

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the accounts service.

Individual Account for Rosters

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

Similar to the All Accounts service, the roster subservice provides a consistent presentation of data for all records, fit for display specifically on a member roster.

HTTP Method Description Conditional Notes
GET Returns account info for the matching user No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No 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 Conditional Notes
GET Returns all users in the matching office No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No 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 Conditional Notes
GET Returns account info for the current user No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Modifies user settings No VOW roles only
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
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",
                "LanguagesSpoken": ["es", "de"],
                "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"
                        ],
                        "PropertyTypes": [
                            "A",
                            "C"
                        ],
                        "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. If changed via update, will transfer a user to a new office.
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.
LanguagesSpoken Character List Yes No Yes The Language codes for the languages the user can speak. See the profile response description for more information.
LicenseNumber Character Yes No No The license number of this user. Must be between 1 and 100 characters long.
NrdsId Integer Yes No No The identifier for this user to NRDS.
OwnerId Character Office Only No No The Id of the designated broker.
PostalCode Character No No Yes For searching only. References Address.PostalCode.
ShortId Character Yes No No The short identifier for this user in the system. Must be between 1 and 15 characters long. Must be unique by UserType (i.e. Member/Office)
Tags Character List No No No The identifier for this user to NRDS.
Profile Fields Various types Yes 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.
Permissions Expansion Fields that define per-user permissions for various resources.
Editable Boolean No No No true if the current user may edit the user record being retrieved.
EditableSettings Character List No No No A list of editable actions the current user can take on the account record.Possible values: PasswordChange
Settings Expansion Fields that define per-user settings, such as whether or not the user has access to the system.
Visible Boolean No No No If false, the user cannot be retrieved in accounts search results.
Active Boolean Member/Office UserTypes Only No No When false, the user's account is considered inactive, and their profile data should not show on roster reports. This attribute is never false when SystemAccess is true.
SystemAccess Boolean Member/Office UserTypes Only No No Indicates whether the user has system access to flexmls or Spark API. Only seen if you have write permissions.
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.
SearchRestrictions. PropertyTypes Character List No No No An array of PropertyType values the user is limited to when searching listings. If null, the user has no restrictions.
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.
Searching by Name

When a wildcard is used on the account Name attribute and no white space 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*'.

When a list of wildcard criteria is provided (e.g. Name Eq 'john*','tim*'), this special searching will only be used if none of the criteria has a white space in it.

Expansions

Expansion Roles Single Record Only? Selection Support? Description
Biography All No No Text that provides a brief biographical background for the user.
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.