Privileged API Keys Only
Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.

Developers: Identities

Identity records track contact information for developers building applications on Spark API. These records are scoped to and MLS or association, and are only accessible by MLS or Association level staff.

  1. Supported Roles
  2. Available Services
    1. All Developer Identities
    2. Deleted Developer Identities
    3. Individual Developer Identity
  3. Developer Identity 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 Yes Only accessible by MLS and association users, and by API keys granted explicit permission.
More information about roles may be found here.

Available Services

All Developer Identities

/<API Version>/developers/identities

HTTP Method Description Conditional Notes
GET Returns all developer identity records accessible by the current user. No
POST Creates a new developer identity record. No
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
Standard search and paging syntax No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
          {
            "Id": 5,
            "ResourceUri": "/vX/developers/identities/5",
            "FirstName": "Joe",
            "LastName": "Developer",
            "Company": "FBS Data Systems",
            "Email": "joe@fbsdata.com",
            "Website": "http://joe.fbsdata.com",
            "Phone": "555-5555",
            "Comments": null,
            "MlsId": "20160223165020414374000000",
            "LastActive": "2012-03-07T21:13:11Z",
            "Editable" : true,
            "Deleted" : false,
            "ModificationTimestamp": "2014-06-27T10:01:06-05:00",
            "CreatedTimestamp": "2014-06-27T10:01:06-05:00",
            "AdditionalContacts": [
              {
                "Name": "John Developer",
                "Type": "Technical",
                "Email": "john@fbsdata.com",
                "Phone": "5559261221"
              }
            ],
            "User": {
              "Id": "20110112234857732941000000",
              "ResourceUri": "/v1/accounts/20110112234857732941000000",
              "UserType": "Member",
              "Name": "Joe Realtor",
              "OfficeId": "20100113238853732842000000",
              "Office": "Joe's Realty",
              "CompanyId": null,
              "Company": null,
              "FbsIdxCustomer": false,
              "MlsId": "20100127075503180752000000"
            }
          }
        ]
    }
}

POST Request

Request body: 
{
    "D": {
      "FirstName": "Joe",
      "LastName": "Developer",
      "Company": "FBS Data Systems",
      "Email": "joe@fbsdata.com",
      "Website": "http://joe.fbsdata.com",
      "Phone": "555-5555"
    }
}

POST Response

The standard success/fail response is returned.

Deleted Developer Identity

/<API Version>/developers/identities/deleted

For reporting and billing purposes, API identities are soft-deleted.

HTTP Method Description Conditional Notes
GET Returns all identities that have been deleted 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 identities service.

Individual Developer Identity

/<API Version>/developers/identities/<Identity.Id>

HTTP Method Description Conditional Notes
GET Returns a single developer identity record. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Updates an identity record No
DELETE Deletes a developer identity record, and all associated data. No

GET Request

Parameters:
  • None

GET Response

See the GET request section for for the identities service.

PUT Request

Request body: 
{
    "D": {
      "Email": "joe@fbsdata.com",
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Developers: Identity Description

Attribute Data Type Writeable Required Searchable Description
Id Integer No No No The unique id for the identity account.
ResourceUri Character No No No The URI to the individual identity account.
MlsId Character No No Yes The ID of the MLS the developer and their keys belong to.
FirstName Character Yes Yes No The first name of the developer the identity belongs to.
LastName Character Yes Yes No The last name of the developer the identity belongs to.
Company Character Yes Yes No The name of the company the developer is associated with.
Email Character Yes No No The primary e-mail address for the developer.
Phone Character Yes No No The primary phone number for the developer.
Website Character Yes No No The primary web site for the developer or their company.
LastActive Timestamp No No Yes The last date and time an API key owned by this identity accessed Spark API. Note: this is only accurate to the day, as the timestamp is updated at most once per day.
Comments Character Yes No No Additional comments or notes regarding the developer or their company.
Editable Boolean No No If true, the current user can modify the identity record.
Deleted Boolean No No If true, the record has been deleted by a user, and is no longer an active identity. These records are omitted from the All Developer Keys service, but are directly accessible by ID or from the deleted identities service.
CreatedTimestamp Timestamp No No No The time the identity was created.
ModificationTimestamp Timestamp No No No The time the identity was last updated.
Key Character No No Yes This is an attribute which will be present, but it is searchable in order to find an Identity related to a specific key.
User Accounts Yes No The account information for the user associated with the identity. Writable by supplying either User.Id or User.LoginName.
"User"."Id" Character No No Yes Users can be filtered by "User"."Id". This search criteria only supports the Eq operator, and does not allow a value of NULL.
AdditionalContacts JSON Object Yes No Additional contact information for the identity.
Name Character Yes Yes The name of the person whose contact information is referenced.
Type Character Yes Yes Must be either Billing or Technical.
Email Character Yes Yes The e-mail address. Must be unique per identity.
Phone Character Yes No The phone number.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.