MoxiCloud API Introduction

API Overview

The MoxiCloud API allows partner access to MoxiWorks Data.

Examples: See examples here for information on accessing resources using various languages.

Introduction

Production Base URL: https://api.moxiworks.com/

QA Base URL: https://api-qa.moxiworks.com/

The MoxiWorks API provides programmatic access to MoxiWorks features and data. We do our best to adhere to open and accepted common standards, including REST for access, JSON format for the data, and HTTP Basic Auth for Authorization.

The URL for the production version of the MoxiWorks API is referenced in the API Usage section of the documentation. When developing your integration into the MoxiWorks Platform using QA credentials, you can replace the production URL with the QA URL. The hostname for the QA environment is https://api-qa.moxiworks.com instead of api.moxiworks.com. In any production URL referenced in the documentation, simply subsitute the QA hostname for the production hostname.

Client Libraries

The following libraries are available to help your integration process with the MoxiWorks Platform public API:

Install .Net Library: dotnet add package MoxiWorks.Platform

.Net

.Net client libraries for the MoxiWorks Platform can be found on nuget.org and installed using Visual Studio.

Install Ruby Library: gem install moxiworks_platform

Ruby

Ruby client libraries for the MoxiWorks Platform can be found on rubygems.org and installed using gem.

Install PHP Library: composer require moxiworks/moxiworks_platform

PHP

PHP client libraries for the MoxiWorks Platform can be found on packagist.org and installed using composer.

RESTful Architecture

The response payload is JSON encoded object(s) with defined structure which reflects a data model.

URL structure follows typical resource-oriented conventions. For example, to get a list of contacts, use GET https://api.moxiworks.com/contacts. This will return a list of Contact objects, where each Contact will have an “id” attribute. To get details on a particular contact, use GET https://api.moxiworks.com/contacts/123456, where 123456 is the “id” of the Contact you want. Similarly, to create a Contact, POST a Contact object to https://api.moxiworks.com/contacts/.

HTTP Standards

All actions taken through the API are done via HTTP using standard HTTP methods: GET (to retrieve an object), POST (to create), PUT (to modify), and DELETE. Standard HTTP Response codes are used to indicate success and error conditions.

Data Security

The MoxiWorks Platform public API requires all requests use HTTPS. Any response to the MoxiWorks Platform API using HTTP will be rejected with a 403 (forbidden) error.

Rate Limiting

To ensure that system resources are not overloaded and response quality degrated, MoxiWorks allows only a limited number of requests every minute.

Over-limit Error Response Example

{
  "status": "fail",
  "errorCode": 4000,
  "message": "'Too many requests. Please try again later."
}

Handling “Rate Limit Exceeded” error In order to prevent abuse and undue stress on the MoxiWorks servers, the API has a rate limiting feature that restricts users to 300 requests per minute per Access Token.

Additionally, requests are accounted by cost. Each endpoint has its own cost based on the overall load put on MoxiWorks systems to generate that response.

If and when the limit is enforced, any requests that exceed this limit will be rejected with an 429 HTTP status code, along with the JSON response body shown to the right

It is recommended that you design your integration to gracefully handle this rate limit error. One way to accomplish this would be to have your integration sleep for 60 seconds when this error is returned from the API, then retry the request. Alternatively, you might choose to use exponential backoff (an error handling strategy whereby you periodically retry a failed request with progressively longer wait times between retries, until either the request succeeds or a specified number of retry attempts is reached).

The MoxiWorks Platform includes rate limiting information in the response headers. The following headers are included in every response:

Response Header	Type	Description
x-ratelimit-limit	Integer	Number of request available in each period
x-ratelimit-remaining	Integer	Requests remaining in current period
x-ratelimit-period	Integer	Rate limit period length (in seconds)
x-ratelimit-reset	Unix Timestamp	Timestamp at which the next period begins
x-ratelimit-cost	Integer	Accounting cost for the provided response.

Session Handling

Set-Cookie Response Example

  
x-frame-options: SAMEORIGIN
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
content-type: application/json; charset=utf-8
cache-control: no-cache
x-request-id: c953f03d-05d6-43e9-baac-995d9b278004
x-runtime: 0.757307
xerver: Moximus
date: Wed, 22 Jan 2017 18:34:44 GMT
content-length: 132
connection: Keep-Alive
set-cookie: _wms_svc_public_session=Y0pzOEdSOGNlRklWSHVkTDVoeE11OU9xVEhoczZuVXJBWGo2Tzk1L0RKOGRwZVBkUnFWMG9nQ2o1QittT3dwN3lZNGVZQXgzSnJPNUp3RGlDS1dKQkZYT3FJQ0ZBaWFLczZTdFl1TjU5VVpRUEx2c29uUHI0cUFhYkUzbDNYMjR6SWdLZjFqM1pNS1dzYmp3dDhkQWw5cjVzMVVOZW1sTndoazNKeThWakhZPS0tNHZBUjk3aGFPbWs3bk9YQlhSbDBRUT09--7faa50a21bc8e09861bc9637eb828a4ce154a980; path=/; HttpOnly

Cookie Request Example

  
PUT /api/tasks/[partner_task_id] HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded
Cookie: _wms_svc_public_session=QlpZQXFoOSs5TGFXZTZ5OVJvQXZIOUhSYSsrYnhXU1Q3cTJHdEd2enJabVdTbjZiWWtnaVFVbURLVmVOV0hEVURLbjZ0NGIzTnE1Mkg2ZEUwMlBLZDZBYWNBSm5xWUk4MWJLUGFFNEREK05Bd0JxZFZWbVp4SFFLVUVyRTdiTXJQb3doMGxkcjZVa3pCNENHZ3RZVWExQncvYkVnPS0tYy9oelpsbWtFd3lxR3VjWkt2ai9rdz09--b46be7a70083e0f70fea4370554b1f0250b3264c; path=/; HttpOnly

The MoxiWorks Platform utilizes Cookie headers in order to propagate session data between requests. Each request is atomic and the session data is used atomically within the request. The session data itself is used to ensure that connection setup is as efficient as possible and to provide higher throughput to authorized users.

If you fail to include session data in your request, you will notice a far lower number of allowed connections to the MoxiWorks Platform than is advertised in Rate Limiting.

When you successfully connect to the MoxiWorks Platform, you will recieve a set-cookie header. The name of the cookie will be _wms_svc_public_session. You’ll need to send this cookie name - value pair back to The MoxiWorks Platform in a Cookie request header.

Example Requests & Responses

For every API operation in this documentation, we show example requests and an example (JSON) response.

You’ll see the examples displayed in the grey panel to the right of each operation.

To view the sample code in a specific language, select the corresponding language tab at the top of the panel to the right. For more information about using the sample code in this API documentation, see Client Libraries.

As with any REST API, you can also test API requests / responses using a Chrome extension like Advanced REST Client (Chrome App) or Postman.

API Changes

Non-breaking changes: New features, functionality and bug fixes will be added to the API over time; you should expect to see new endpoints or new attributes in the payload for existing endpoints. Non-breaking changes will not result in a new API version. Ensure that your API consumer logic can handle new attributes gracefully. Ensure your API consumer logic does not depend on the order in which records are returned, unless static order is explicitly denoted in this documentation.

Breaking changes: Although we intend to support and maintain the current version of the API indefinitely, if changes that break the current API are made, we will publish the api update with a new version number, in order to ensure that the existing API functionality remains available to API consumers relying on that version. When breaking changes are added, the current version of the API will continue to be available.

Deprecations: MoxiWorks occasionally deprecates APIs to indicate that those APIs should no longer be used in active development. Deprecated APIs typically remain present and usable for a reasonable period of time following the release in which they were deprecated; however, they may be removed entirely from a future version of the API as required. You should never use deprecated APIs in new development, and if you have existing code that uses deprecated APIs, we recommend that you update that code as soon as possible.

Required Headers

Required Headers Example

POST /api/[RESOURCE] HTTP/1.1
Authorization: Basic bpiYWFhYWFycnJycnJy==
Content-Type: application/x-www-form-urlencoded
Accept: application/vnd.moxi-platform+json;version=1
Cookie: _wms_svc_public_session=QlpZQXFoOSs5TGFXZT...

# required headers set automatically by moxiworks_platform library.
# to view, use the following:

MoxiworksPlatform::Resource.headers.inspect

<?php
/* required headers seat automatically by moxiworks_platform library.
to view, use the following:
*/
print_r(MoxiworksPlatform\Resource::headers());
?>

If you are implementing your own MoxiWorks Platform library, you’ll need to ensure that you have the following headers configured in your request:


Authorization	Used for platform authorization	`Basic [base64 encoded Partner ID and Partner Secret]`
Accept	Used for API version and resource routing	`application/vnd.moxi-platform+json;version=1`
Content-Type	Used for handling data in request	`application/x-www-form-urlencoded`
Cookie	Used for connection setup and rate limiting	`_wms_svc_public_session`

For more information on the Cookie header, see Session Handling

Authorization

Example Authorization Header: (note that the authorization header platform identifier and platform secret are base64 encoded)

POST /api/[RESOURCE] HTTP/1.1
Authorization: Basic Zm9vb29vb29vb29vbzpiYWFhYWFycnJycnJy==


require 'moxiworks_platform'

platform_identifier = 'abc123' # platorm_identifier provided by MoxiWorks Platform Rep
platform_secret = 'secret' #platform_secret provided by MoxiWorks Platform Rep

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)


<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);
?>

The MoxiWorks API utilizes Authorization HTTP headers for authorization.

To authorize your request, use the API Identifier and Secret combination you have been provided by your MoxiWorks Platform representative.

When composing your basic header, per RFC 2617 you’ll need to base 64 encode your MoxiWorks Platform Identifier and Secret and remember to separate your platform identifier and secret with a colon.

Help with HTTP Basic Auth on your platform

The following links provide helpful information for various platforms on creating HTTP Basic Auth Headers


ColdFusion

Still need more info? Email api@moxiworks.com and let us know what language you’re using to connect to the MoxiWorks Platform.

Request Formatting

Setting Payload Format To Form Data using Content-Type header

POST /api/[RESOURCE] HTTP/1.1
Content-Type: application/x-www-form-urlencoded

moxi_works_agent_id=abc123&partner_contact_id=abc982cdf345&contact_name=Billy+Football

# required headers set automatically by moxiworks_platform library.
# to view, use the following:

MoxiworksPlatform::Resource.content_type_header.inspect

<?php
/* required headers seat automatically by moxiworks_platform library.
to view, use the following: 
*/
print_r(MoxiworksPlatform\Resource::contentTypeHeader());
?>

Setting Payload Format To JSON using Content-Type header

POST /api/[RESOURCE] HTTP/1.1
Content-Type: application/json

# required headers set automatically to x-www-form-urlencoded moxiworks_platform library.

<?php
/* required headers seat automatically to x-www-form-urlencoded by moxiworks_platform library.*/
?>

Your request body payload can either be formatted as JSON or as url encoded form parameters. Whichever method you choose, you’ll need to configure your Content-Type header to match the payload format.

Sending Data

When sending data, your payload should be formatted as a standard encoded form data or JSON.

For GET and DELETE requests, parameters should be embedded in the URL.

For POST, PUT request, the parameters should be included in the entity body of the request.

API Versioning

API Version Embedded In Accept Header

POST /api/[RESOURCE] HTTP/1.1
Accept: application/vnd.moxi-platform+json;version=1

 # accept header api version automatically set by moxiworks_platform in requests
 # to view the version of the API used with your version of  moxiworks_platform Ruby library:

MoxiworksPlatform::Resource.accept_header

 <?php
 /* accept header api version automatically sett by moxiworks_platform in requsts
 to view the version of the API used with your version of moxiworks_platform PHP library:
  */
echo MoxiworksPlatform\Resource::acceptHeader();
?>

MoxiWorks API uses the Accept header to denote the version of the API to be used.

If you are using a MoxiWorks Platform library, this header will already be included with every request.


Accept	The MoxiWorks API uses the Accept header to denote the API version to be used ( `application/vnd.moxi-platform+json;version=[VERSION NUMBER]`).

Error Handling

Error Response Example

{
  "status":"error",
  "messages":["Invalid moxi_works_agent_id"],
  "status_code":1040,
  "request_id":"c1b24426-397d-4855-9389-e39b58b918da"
}

The following table specifies the recommended action for each MoxiWorks API error code.

Use this table to implement error handling logic according to the following guidelines:

• If the error code indicates a permanent error condition, do not retry the request.

• If the error code indicates a problem that can be fixed, do not retry the request until the problem has been fixed.

• If the error code indicates a problem that could be overcome by retrying the request after a period of time, retry the request using exponential backoff.

API Error Code	HTTP Status Code	Message	Recommended Action
1000	400	A required header was missing or invalid:	Fix issue, then retry.
1010	400	A required object attribute is missing from your request.	Fix issue, then retry.
1020	400	Unable to parse request. Error will be included in response payload.	Fix issue, then retry.
1030	400	A required parameter is missing from your request.	Fix issue, then retry.
1040	400	The value was not valid for the parameter.	Fix issue, then retry.
1050	400	The HTTP request body is required for this Method.	Fix issue, then retry.
1060	400	The attribute(s) are not allowed for this operation.	Fix issue, then retry.
1200	400	Malformed data in request.	Fix issue, then retry.
1210	400	Unsupported operation.	Do not retry.
2000	401	Basic Authorization header required.	Fix issue, then retry. Hint: Verify that Authorization header is present and set properly.
2010	401	Your Authorization header is invalid.	Fix issue, then retry. Hint: Verify that the MoxiWorks Platform Identifier and Secret specified in the Authorization header are valid and properly encoded.
2015	401	Unauthorized request.	Do not retry.
2020	403	You are forbidden to perform this action.	Do not retry.
2025	403	You are forbidden to perform this action. Agent does not have access to requested resource.	Do not retry.
3010	404	Version not supported.	Fix issue, then retry.
3015	404	Resource not found.	Fix issue, then retry. Hint: Verify that you are using a valid resource path (i.e. /api/contacts/, /api/events/ etc.)
3020	405	HTTP Method not supported.	Fix issue, then retry. Hint: Verify that the proper verb is specified for the request (GET, PUT, POST, or DELETE).
3030	406	Invalid Accept header.	Fix issue, then retry. Hint: Verify that Accept header is set to the proper value (to match the output of the invoked endpoint – typically “application/json”).
3060	415	Invalid Content-Type header. Media type not supported.	Fix issue, then retry. Hint: Verify that Content-Type header is specified and set to the proper value.
4000	429	Rate limit exceeded.	Retry using exponential backoff. Hint: Reduce the rate at which you are sending requests.
5000	500	An unexpected error has occurred. Please contact api@moxiworks.com for assistance.	Do not retry.
5010	500	An unexpected error has occurred. Please retry your request. If you encounter this error repeatedly, please contact api@moxiworks.com for assistance.	Retry using exponential backoff.
5020	500	Server timeout exceeded. Request has failed.	Retry using exponential backoff.
5030	503	api.moxiworks.com is currently offline for system maintenance. Please check back again shortly.	Retry using exponential backoff. Hint: Wait time between retries should measure in minutes (not seconds).
5035	503	Upstream provider overloaded. Please try again shortly.	Retry using exponential backoff. Hint: Wait time between retries should measure in minutes (not seconds).
5045	503	Agent configuration issue.	Contact agent to ensure they have provided Moxi Engage correct permissions to access their provider account.
5055	503	Agent configuration issue.	Agent has not provided Moxi Engage access to their address book. Contact agent to ensure they provide Moxi Engage permission to access their address book.
5065	503	Agent configuration issue.	Agent has not provided Moxi Engage access to their calendar. Contact agetn to ensure that they provide Moxi Engage permission to access their calendar.

Agent Identifiers

The MoxiWorks Platform provides several agent identifiers to support flexibility for differing use-cases.

agent_uuid If you are pulling agent data from The MoxiWorks Platform and integrating with your own system in a managed or automated fashion, then using agent_uuid request attribute is preferable. It is guaranteed to be unique and to never change for the lifetime of the account.

moxi_works_agent_id If you have already existing agent data, agent accounts and your own user interface that agents can use to integrate your account with their MoxiWorks Platform account then you should use the moxi_works_agent_id request attribute. This identifier is guaranteed to be unique, but may be either an alphanumeric string or an email address. It is intended for use cases where integration is managed by end-user interaction..

source_agent_id If you have access to agent data from the same company source that MoxiWorks uses as an upstream data source then you should use the source_agent_id request attribute. This identifier will be unique only within the scope of a given company or parent_company, and must be used in conjunction with the moxi_works_company_id or parent_company_id request attributes. Please email partners@moxiworks.com for clarification about this request attribute.

MoxiCloud API Reference

API Endpoint Usage

Use the following section to determine the request requirements and payload structure for MoxiWorks Platform endpoints.

ActionLog

MoxiWorks ActionLog entries record actions that contacts take that an agent might want to see to increase their effectivity. For example, if a contact sends an email to an agent asking a question, MoxiWorks ActionLog will record that interaction and display it to the agent.

ActionLog Create

Ruby Create Docs

PHP Create Docs

.Net ActionLogService.CreateActionLogAsync Docs

ActionLog Create (using agent_uuid) Request Example

{
  "agent_uuid":"12345678-1234-1234-1234-1234567890ab",
  "partner_contact_id":"mySystemsContactId",
  "title":"Contact Called",
  "body":"this contact called you"
}

POST /api/action_logs HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded


agent_uuid=12345678-1234-1234-1234-1234567890ab&partner_contact_id=mySystemsContactId&title=Contact%20Called&body=this%20contact%20called%20you


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";


var actionLog = new ActionLog();
actionLog.AgentUuid = "12345678-1234-1234-1234-1234567890ab";
actionLog.Title = "Contact Called";
actionLog.Body = "this contact called you";
actionLog.PartnerContactId = "mySystemsContactId";

var service = new ActionLogService(new MoxiWorksClient());
var result = service.CreateActionLogAsync(actionLog).Result;

###### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisites

moxi_works_action_log = MoxiworksPlatform::ActionLog.create(
        agent_uuid: "12345678-1234-1234-1234-1234567890ab",
        partner_contact_id: "mySystemsContactId",
        title: "Contact Called",
        body: "this contact called you"
        )

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$moxi_works_action_log = MoxiworksPlatform\ActionLog::create([
        'agent_uuid' => '12345678-1234-1234-1234-1234567890ab',
        'partner_contact_id' => 'mySystemsContactId',
        'title' => 'Contact Called',
        'body' => 'this contact called you']);
?>

ActionLog Create (using moxi_works_agent_id) Request Example

{
  "moxi_works_agent_id":"abc123",
  "partner_contact_id":"mySystemsContactId",
  "title":"Contact Called",
  "body":"this contact called you"
}

POST /api/action_logs HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded


moxi_works_agent_id=abc123&partner_contact_id=mySystemsContactId&title=Contact%20Called&body=this%20contact%20called%20you


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";


var actionLog = ActionLog.new();
actionLog.MoxiWorksAgentId = "abc123";
actionLog.Title = "Contact Called";
actionLog.Body = "this contact called you";
actionLog.PartnerContactId = "mySystemsContactId";

var service = new ActionLogService(new MoxiWorksClient());
var result = service.CreateActionLogAsync(actionLog).Result;

###### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisites

moxi_works_action_log = MoxiworksPlatform::ActionLog.create(
        moxi_works_agent_id: "1234abcd",
        partner_contact_id: "mySystemsContactId",
        title: "Contact Called",
        body: "this contact called you"
        )

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$moxi_works_action_log = MoxiworksPlatform\ActionLog::create([
        'moxi_works_agent_id' => '1234abcd',
        'partner_contact_id' => 'mySystemsContactId',
        'title' => 'Contact Called',
        'body' => 'this contact called you']);
?>

When creating an ActionLog using the MoxiWorks platform API, format your request using the following parameters.

ActionLog Create Request Attributes

Attribute	Type	Length Limit
agent_uuid*	String	255
moxi_works_agent_id*	String	255
source_agent_id*	String	255
body	String	255
moxi_works_contact_id †	String	255
partner_contact_id †	String	255
title	String	85
moxi_works_company_id	String
parent_company_id	String	255
agent_action	String	255
agent_action_address	String	255
agent_action_address2	String	255
agent_action_city	String	255
agent_action_state	String	255
agent_action_zip	String	255

Required Parameters Are In Red

† Either moxi_works_contact_id or partner_contact_id must be supplied.

moxi_works_agent_id or agent_uuid or source_agent_id One of these parameters must be supplied Please reference Agent Identifiers for information about how to construct your agent identifier request params.

moxi_works_company_id A valid MoxiWorks Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.

parent_company_id This is the numeric_id or moxi_works_company_id of a company that is considered to be a parent company in the MoxiWorks Platform. This request attribute has two functions:

1. It provides for a broad scope by which partners may be afforded permissions to perform MoxiWorks Platform actions, in scenarios where a partner does business with a parent company in the MoxiWorks System.
2. It provides broad scope under which agents may be looked up using the source_agent_id request attribute in many scenarios across different MoxiWorks Platform endpoints and actions.

Please note that this attribute cannot be used as a replacement for the moxi_works_company_id request attribute in scenarios where the moxi_works_company_id request attribute is required by the action.

Please note that this attribute cannot be used to broaden scope of any request where the scope of the request is defined by the moxi_works_company_id request attribute.

Please note that when passed in conjunction with the moxi_works_company_id request attribute, the value of moxi_works_company_id request attribute must be the numeric id form.

Any use of this request attribute must be coordinated with MoxiWorks Platform Partner services. Please reach out to partner services for more information.

body This is a human readable string which would be presented to the Agent as the content of the ActionLog entry. This can be any arbitrary plain-text string which would be practical for the agent to see in the history of events associated with a Contact. It must be greater than 0 and must be less than 5000 characters (including white space).

moxi_works_contact_id This is the MoxiWorks Platform ID of the Contact which this ActionLog object is to be associated with. This will be an RFC 4122 compliant UUID. This data is required and must reference a valid MoxiWorks Contact ID for your ActionLog Create request to be accepted. This is the same as the moxi_works_contact_id attribute of the Contact response.

partner_contact_id This is the unique identifer you use in your system that has been associated with the Contact that you are creating an ActionLog entry about. You should have already created the Contact record on the MoxiWorks Platform using Contact Create before attempting to use the contact ID to create an ActionLog entry about the Contact. Your request will be rejected if the Contact record does not exist.

title This is the human readable plain-text string which will be presented to the Agent as the heading of the ActionLog entry. This can be any short, descriptive sentence which would be practical for the agent to see in the history of events associated with a Contact.

agent_action This is the human readable plain-text string which will be presented to the Agent as the heading of the ActionLog entry. This can be any short, descriptive sentence which would be practical for the agent to see in the history of events associated with a Contact.

agent_action_address If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the street address of the agent_action.

agent_action_address2 If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the additonal street address info of the agent_action.

agent_action_city If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the city or locale of the agent_action.

agent_action_state If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the state or province of the agent_action.

agent_action_zip If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the postal code of the agent_action.

ActionLog Create Response Payload

The following attributes make up the payload of the ActionLog response for a Create request.

ActionLog Create (using agent_uuid) Response Payload Example


  {
  "agent_uuid": "12345678-1234-1234-1234-1234567890ab",
  "partner_contact_id": "mySystemsContactId",
  "type": "log_entry_type",
  "timestamp": 1462234227,
  "title": "Contact Called",
  "body": "this contact called you"
}

ActionLog Create (using moxi_works_agent_id and moxi_works_contact_id) Response Payload Example


  {
  "moxi_works_agent_id": "1234abcd",
  "moxi_works_contact_id": "22345678-1234-1234-1234-1234567890ab",
  "type": "log_entry_type",
  "timestamp": 1462234227,
  "title": "Contact Called",
  "body": "this contact called you"
}

ActionLog Create Failure Response
See Error Handling for details about individual error codes.

{
  "status":"fail",
  "errorCode": xxx,
  "messages": ["messages"]
}

Create Response Attributes

Attribute	Type
agent_uuid*	String
moxi_works_agent_id*	String
body	String
moxi_works_contact_id †	String
partner_contact_id †	String
timestamp	Integer
title	String
agent_action	String
agent_action_address	String
agent_action_address2	String
agent_action_city	String
agent_action_state	String
agent_action_zip	String

* Either agent_uuid or moxi_works_agent_id will be returned depending on whether it is used in the request. The response payload object’s agent identifier key will match the passed parameter.

† Either moxi_works_contact_id or partner_contact_id will be returned depending on whether it is used in the request. The response payload object’s agent identifier key will match the passed parameter.

agent_uuid This is the MoxiWorks Platform ID of the agent which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID.

moxi_works_agent_id This is the MoxiWorks Platform ID of the agent which an ActionLog entry is associated with. This will be a string that may take the form of an email address, or a unique identification string.

body This is a human readable string which would be presented to the Agent as the content of the ActionLog entry. This can be any arbitrary plain-text string which would be practical for the agent to see in the history of events associated with a Contact. This should be the same as the data sent in the body parameter of the ActionLog Create request.

moxi_works_contact_id This is the MoxiWorks Platform ID of the Contact that you are creating an ActionLog entry about. This will be an RFC 4122 compliant UUID.

timestamp This is the Unix timestamp for the creation time of the ActionLog entry.

title This is the human readable plain-text string which will be presented to the Agent as the heading of the ActionLog entry. This may be any short, descriptive sentence which would be practical for the agent to see in the history of events associated with a Contact. This should be the same as the data sent in the title parameter of the ActionLog Create request.

agent_action If creating an agent_action, this field will denote what kind of agent_action is being created. You can create an inperson, mail, email, social, text, voicemail, phone or other

agent_action_address If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the street address of the agent_action.

agent_action_address2 If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the additonal street address info of the agent_action.

agent_action_city If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the city or locale of the agent_action.

agent_action_state If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the state or province of the agent_action.

agent_action_zip If creating an agent_action that has a location component (‘inperson’ ‘other’) use this field to denote the postal code of the agent_action.

ActionLog Delete

Ruby Delete Docs

PHP Delete Docs

.Net ActionLogService.DeleteActionLogAsync Docs

ActionLog Delete (using agent_uuid) Request Example

{
  "moxi_works_action_log_id":"12345678-1234-1234-1234-1234567890ab",
}

POST /api/action_logs HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded


moxi_works_action_log_id=12345678-1234-1234-1234-1234567890ab


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";


var actionLog = new ActionLog();
actionLog.MoxiWorksActionLogId = "12345678-1234-1234-1234-1234567890ab";

var service = new ActionLogService(new MoxiWorksClient());
var result = service.DeleteActionLogAsync(actionLog).Result;

###### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisites

moxi_works_action_log = MoxiworksPlatform::ActionLog.delete(
    moxi_works_action_log_id: "12345678-1234-1234-1234-1234567890ab"      )

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$moxi_works_action_log = MoxiworksPlatform\ActionLog::delete([
        'moxi_works_action_log_id' => '12345678-1234-1234-1234-1234567890ab']);
?>

When deleting an ActionLog using the MoxiWorks platform API, format your request using the following parameters.

ActionLog Delete Request Attributes

Attribute	Type	Length Limit
moxi_works_action_log_id	String	255
agent_uuid*	String	255
moxi_works_agent_id*	String	255
source_agent_id*	String	255
moxi_works_company_id	String
parent_company_id	String	255

Required Parameters Are In Red

moxi_works_action_log_id This is the MoxiWorks Platform ID of the ActionLog entry to be deleted. This will be an RFC 4122 compliant UUID.

moxi_works_company_id A valid MoxiWorks Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.

ActionLog Delete Response Payload

The following attributes make up the payload of the ActionLog response for a Delete request.

ActionLog Delete Response Payload Example


{
    "status": "success",
    "deleted": true,
    "messages": [
        "ActionLog entry a0be9654-06df-44f0-af8c-057967cf579a deleted"
    ]
}

ActionLog Delete Failure Response
See Error Handling for details about individual error codes.

{
  "status":"fail",
  "errorCode": xxx,
  "messages": ["messages"]
}

Delete Response Attributes

Attribute	Type
status	String
deleted	Boolean
messages	Array

status This will indicate what the status of the request is.

deleted This will indicate whether the delete request was successful or not.

messages This is an arrray of strings. Any messages associated with the delete request status will be contained in this array.

ActionLog Index

Ruby Search Docs

PHP Search Docs

.Net ActionLogService.GetActionLogsAsync Docs

When searching for ActionLog entities using the MoxiWorks platform API, format your request using the following parameters.

ActionLog Index (using agent_uuid Request Example

{
  "agent_uuid":"12345678-1234-1234-1234-1234567890ab",
  "partner_contact_id":"mySystemsContactId","
  "date_min": 1569860000,
  "date_max": 1569870000
}

GET /api/action_logs?agent_uuid=12345678-1234-1234-1234-1234567890ab&partner_contact_id=mySystemsContactId HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";


var agentUuid = "12345678-1234-1234-1234-1234567890ab";

var service = new ActionLogService(new MoxiWorksClient());
var results = service.GetActionLogsAsync(agentUuid, AgentIdType.AgentUuid, "mySystemsContactId").Result;

##### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisitesa

moxi_works_action_log_entries = MoxiworksPlatform::ActionLog.search(
        agent_uuid: "12345678-1234-1234-1234-1234567890ab",
        partner_contact_id: "mySystemsContactId")

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$moxi_works_action_log_entries = MoxiworksPlatform\ActionLog::search([
        'agent_uuid' => '12345678-1234-1234-1234-1234567890ab',
        'partner_contact_id' => 'mySystemsContactId']);

?>

ActionLog Index (using moxi_works_agent_id Request Example

{
  "moxi_works_agent_id":"abc123",
  "partner_contact_id":"mySystemsContactId"
}

GET /api/action_logs?moxi_works_agent_id=abc123&partner_contact_id=mySystemsContactId HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";


var moxiWorksAgentId = "abcd1234";

var service = new ActionLogService(new MoxiWorksClient());
var results = service.GetActionLogsAsync( moxiWorksAgentId,  AgentIdType.MoxiWorksAgentId,  "mySystemsContactId").Result;

##### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisitesa

moxi_works_action_log_entries = MoxiworksPlatform::ActionLog.search(
        moxi_works_agent_id: "1234abcd",
        partner_contact_id: "mySystemsContactId")

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$moxi_works_action_log_entries = MoxiworksPlatform\ActionLog::search([
        'moxi_works_agent_id' => '1234abcd',
        'partner_contact_id' => 'mySystemsContactId']);

?>

ActionLog Index Request Attributes

Attribute	Type	Length Limit
agent_uuid*	String	255
moxi_works_agent_id*	String	255
source_agent_id*	String	255
moxi_works_contact_id †	String	255
partner_contact_id †	String	255
moxi_works_company_id	String
parent_company_id	String	255
date_min	Integer	255
date_max	Integer	255

Required Parameters Are In Red

† Either moxi_works_contact_id or partner_contact_id must be supplied.

moxi_works_company_id A valid MoxiWorks Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.

moxi_works_contact_id This is the MoxiWorks Platform ID of the Contact which the ActionLog objects are associated with. This will be an RFC 4122 compliant UUID. This data is required and must reference a valid MoxiWorks Contact ID for your ActionLog Index request to be accepted. This is the same as the moxi_works_contact_id attribute of the Contact response.

partner_contact_id This is the unique identifer you use in your system that has been associated with the Contact that you are creating an ActionLog entry about. You should have already created the Contact record on the MoxiWorks Platform using Contact Create before attempting to use your system’s contact ID to show ActionLog entries for the Contact. Your request will be rejected if the Contact record does not exist.

date_min Only ActionLog records created later than this Unix timestamp will be included in the query. The upper bound of the time slice will be the 90 days higher than date_min value or the value of the the date_max; whichever is lower. If no timestamps are provided, ActionLogs from the last 90 days will be retrieved.

date_max Only ActionLog records created earlier than this Unix timestamp will be included in the query. Should be no higher than 90 days past the date_min attribute if it is provided.

ActionLog Index Response Payload

The following attributes make up the payload of the ActionLog response for a Index request.

ActionLog Index (using agent_uuid) Response Payload Example


{
  "agent_uuid": "1234abcd",
  "partner_contact_id": "11111abe",
  "actions": [
  {
    "moxi_works_action_log_id": "02b918",
    "type": "lead_update_api",
    "log_data": {
      "source": "datplace",
      "timestamp": "1465937163",
      "user_info": {
        "property_info":{},
        "search_criteria":{},
        "contact":{
          "first_name":null,
          "message":"",
          "source":"datplace"
        }
      }
    }
  }
  {
    "moxi_works_action_log_id": "bded1806-3271-11e6-9bb3-5254000f954a",
    "type": "lead_update_api",
    "log_data": {
      "source": "foo.what",
      "timestamp": "1465937477",
      "user_info": {
        "property_info":{
          "PropertyURL":"www.wat.com",
          "MLSNumber":"",
          "StreetAddress":"",
          "City":"",
          "State":"",
          "Zip":"",
          "Beds":"",
          "Baths":"",
          "ListingPrice":"",
          "ListingStatus":"",
          "PhotoURL":""
        },
        "search_criteria":{},
        "contact":{
          "first_name":null,
          "message":"",
          "source":"foo.what"
        }
      }
    }
  }
  ]
}

ActionLog Index Response Payload Example (using moxi_works_agent_id)


{
  "moxi_works_agent_id": "1234abcd",
  "partner_contact_id": "11111abe",
  "actions": [
  {
    "moxi_works_action_log_id": "02b918",
    "type": "lead_update_api",
    "log_data": {
      "source": "datplace",
      "timestamp": "1465937163",
      "user_info": {
        "property_info":{},
        "search_criteria":{},
        "contact":{
          "first_name":null,
          "message":"",
          "source":"datplace"
        }
      }
    }
  }
  {
    "moxi_works_action_log_id": "bded1806-3271-11e6-9bb3-5254000f954a",
    "type": "lead_update_api",
    "log_data": {
      "source": "foo.what",
      "timestamp": "1465937477",
      "user_info": {
        "property_info":{
          "PropertyURL":"www.wat.com",
          "MLSNumber":"",
          "StreetAddress":"",
          "City":"",
          "State":"",
          "Zip":"",
          "Beds":"",
          "Baths":"",
          "ListingPrice":"",
          "ListingStatus":"",
          "PhotoURL":""
        },
        "search_criteria":{},
        "contact":{
          "first_name":null,
          "message":"",
          "source":"foo.what"
        }
      }
    }
  }
  ]
}

ActionLog Index Failure Response
See Error Handling for details about individual error codes.


{
  "status":"fail",
  "errorCode": xxx,
  "messages": ["messages"]
}

Index Response Attributes

Attribute	Type
agent_uuid*	String
moxi_works_agent_id*	String
moxi_works_contact_id †	String
partner_contact_id †	String
actions	Array

* Either agent_uuid or moxi_works_agent_id will be returned depending on whether it is used in the request. The response payload object’s agent identifier key will match the passed parameter.

agent_uuid This is the MoxiWorks Platform ID of the Agent which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID.

moxi_works_agent_id This is the MoxiWorks Platform ID of the Agent which an action log entry is associated with. This will be a string that may take the form of an email address, or a unique alphanumeric identification string.

moxi_works_contact_id This is the MoxiWorks Platform ID of this Contact that this ActionLog entry is about. This will be an RFC 4122 compliant UUID.

partner_contact_id This is the unique identifer you use in your system that has been associated with the Contact that this ActionLog entry is about.

actions This is an Array containing any ActionLog entries found for the Index request.

actions Object

The actions array contains Dictionary objects representing ActionLog entries. The structure of each ActionLog entry is shown below.

Attribute	Type
moxi_works_action_log_id	String
type	String
timestamp	Integer
log_data	Dictionary

moxi_works_action_log_id This is the unique identifier for the MoxiWorks Platform ActionLog entry.

type This is a string from an enumerated set representing the type of ActionLog entry this is. The string should be formatted in lowercase with an underscore between each word. Individual ActionLog types are outside the scope of this document.

timestamp This is the Unix timestamp for the creation time of the ActionLog entry.

log_data This is the payload data of the ActionLog entry. The structure returned is dependent on the kind of ActionLog entry this is. Use the type attribute to determine what the structure of the ActionLog entry is and how to handle it. Details of various structures contained in ActionLog log_data is outside the scope of this documentation.

Agent

MoxiWorks Agent objects contain data about agents that your organization can use. For example, you can determine an agent’s office address or primary phone number from an Agent object.

Agent Show

Ruby Find Docs

PHP Find Docs

.Net AgentService.GetAgentAsync Docs

Agent Show (using agent_uuid) Example

GET /api/agents/[agent_uuid]&moxi_works_company_id=[moxi_works_company_id] HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded

{
  "agent_uuid":"12345678-1234-1234-1234-1234567890ab",
  "moxi_works_company_id":"the_company"
}


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";

var service = new AgentService(new MoxiWorksClient());
var result = service.GetAgentAsync( "12345678-1234-1234-1234-1234567890ab",  "the_company").Result;

##### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisites

moxi_works_agent = MoxiworksPlatform::Agent.find(
        agent_uuid: "12345678-1234-1234-1234-1234567890ab",
        moxi_works_company_id: "abc123")

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$moxi_works_agent = MoxiworksPlatform\Agent::find([
        'agent_uuid' => '12345678-1234-1234-1234-1234567890ab',
        'moxi_works_company_id' => 'abc123']);
?>

Agent Show (using moxi_works_agent_id) Example

GET /api/agents/[moxi_works_agent_id]&moxi_works_company_id=[moxi_works_company_id] HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded

{
  "moxi_works_agent_id":"abc123",
  "moxi_works_company_id":"the_company"
}


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";

var service = new AgentService(new MoxiWorksClient());
var result = service.GetAgentAsync("some_agent_id","some_company_id").Result;

##### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisites

moxi_works_agent = MoxiworksPlatform::Agent.find(
        moxi_works_agent_id: "1234abcd",
        moxi_works_company_id: "abc123")

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$moxi_works_agent = MoxiworksPlatform\Agent::find([
        'moxi_works_agent_id' => '1234abcd',
        'moxi_works_company_id' => 'abc123']);
?>

Agent Show Request Attributes

When finding an Agent using the MoxiWorks platform API, format your request using the following parameters.

Attribute	Type	Length Limit
agent_uuid*	String	255
moxi_works_agent_id*	String	255
source_agent_id*	String	255
moxi_works_company_id	String	255
parent_company_id	String	255
include_access_level	Boolean	255
include_gci_goals	Boolean	255
include_partners	Boolean	255
include_reviews	Boolean	255

Required Parameters Are In Red

moxi_works_company_id A valid MoxiWorks Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.

include_access_level To include access level information for the agent in the response, pass true

include_gci_goals Whether to include agent’s GCI goals and commissions data in the response data.

include_partners To include affiliate data associated with the agent in the response, pass true.

include_reviews To include ratings and reviews associated with the agent in the response, pass true.

Agent Show Response Payload

The following attributes make up the payload of the Agent response for a Show request.

Agent Index Response Payload Example

{
  "moxi_works_agent_id": "abc123",
  "client_agent_id":"abc123",
  "mls_agent_id":"MLS_ID",
  "license":"abc123lic",
  "mls_name":"Bob's Better MLS",
  "mls_abbreviation":"BBM",
  "moxi_works_office_id":"8c3f446c-aab9-11e6-9a0f-d0e1408e8026",
  "office_id":"1234",
  "client_office_id":"987123",
  "company_id":"2345",
  "client_company_id":"abc392",
  "agent_id":"67890",
  "office_address_street": "3456 Office Ln.",
  "office_address_street2":"Suite 1234",
  "office_address_city": "Officeville",
  "office_address_state": "AG",
  "office_address_zip": "12345",
  "office_mailing_address_street": "1236 Mailbox Ave.",
  "office_mailing_address_street2":"Box 43",
  "office_mailing_address_city": "Mailtown",
  "office_mailing_address_state": "AG",
  "office_mailing_address_zip": "12348",
  "name": "Buckminster Fuller",
  "first_name": "Buckminster",
  "last_name": "Fuller",
  "main_phone_number": "555) 9101112",
  "mobile_phone_number": "555 333 4567",
  "alt_phone_number": "(555) 567-8910",
  "fax_phone_number": "5557891011",
  "office_phone_number": "(234)456-7890",
  "primary_email_address": "the_agent@agentdomain.com",
  "secondary_email_address": "the_agent_alt@otherdomain.com",
  "email_addresses": {
    "primary": "primary@email.com",
    "display": "display@email.com",
    "alternate": null,
    "moxi_sync": "moxi@email.com",
    "lead_routing": "lead@email.com",
    "zillow": null
  },
  "lead_routing_email_address":"leadrouter@thisdomain.com",
  "title": "Broker",
  "designations": "Realtor, CRS, SRES",
  "uuid":"8675309e9-1234-dead-beef-deadbeefdead",
  "has_engage_access":true,
  "website_base_url": "mymoxi@website.com",
  "twitter": "https://twitter.com/agentguy",
  "google_plus": "https://plus.google.com/1234567891011121314/posts",
  "facebook": "https://www.facebook.com/moxiworks/",
  "home_page": "foo.com",
  "profile_image_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=200",
  "profile_thumb_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=75",
  "service_area_zip_codes": [
    "98117",
    "98105"
  ],
  "agent_website": {
    "base_url": "http://mymoxi@website.com",
    "bio_page_slug": "/profile/main.profile"
  },
  "company_programs": [
    "Deluxe Listings agent",
    "Very Cool Program Manager"
  ],
  "alternate_offices": [
  {
    "moxi_works_office_id": "abc123",
    "office_id": 1234,
    "office_address_street": "2636 NW Office Street",
    "office_address_street2": null,
    "office_address_city": "Altville",
    "office_address_state": "IN",
    "office_address_zip": "23232",
    "office_phone_number": "813.555.1221"
    },
      {
    "moxi_works_office_id": "xyz789",
    "office_id": 5678,
    "office_address_street": "700 123rd Ave",
    "office_address_street2": "Suite 1234",
    "office_address_city": "Nextus",
    "office_address_state": "AL",
    "office_address_zip": "99899",
    "office_phone_number": "66655544444"
    }
  ],
  "source_metadata": [
    {
      "identifier_source": "moxi",
      "identifier_type": "external_identifier",
      "identifier_key": "abc12345"
    },
    {
      "identifier_source": "moxi",
      "identifier_type": "external_identifier_alt",
      "identifier_key": "xyz99999"
    }
  ],
  "profile_visible_online": true,
  "user_reviews": [
    {
      "source_name": "zillow",
      "agg_rating": 5,
      "reviews_count": 10
    }
  ]
}

Agent Index Response Payload Example when include_gci_goals is `true`

{
  "moxi_works_agent_id": "abc123",
  "client_agent_id":"abc123",
  "mls_agent_id":"MLS_ID",
  "license":"abc123lic",
  "mls_name":"Bob's Better MLS",
  "mls_abbreviation":"BBM",
  "moxi_works_office_id":"8c3f446c-aab9-11e6-9a0f-d0e1408e8026",
  "office_id":"1234",
  "client_office_id":"987123",
  "company_id":"2345",
  "client_company_id":"abc392",
  "agent_id":"67890",
  "office_address_street": "3456 Office Ln.",
  "office_address_street2":"Suite 1234",
  "office_address_city": "Officeville",
  "office_address_state": "AG",
  "office_address_zip": "12345",
  "office_mailing_address_street": "3453 Mailbox Ave.",
  "office_mailing_address_street2":"Box 11",
  "office_mailing_address_city": "Mailtown",
  "office_mailing_address_state": "AG",
  "office_mailing_address_zip": "12342",
  "name": "Buckminster Fuller",
  "first_name": "Buckminster",
  "last_name": "Fuller",
  "main_phone_number": "555) 9101112",
  "mobile_phone_number": "555 333 4567",
  "alt_phone_number": "(555) 567-8910",
  "fax_phone_number": "5557891011",
  "office_phone_number": "(234)456-7890",
  "primary_email_address": "the_agent@agentdomain.com",
  "secondary_email_address": "the_agent_alt@otherdomain.com",
  "email_addresses": {
    "primary": "primary@email.com",
    "display": "display@email.com",
    "alternate": null,
    "moxi_sync": "moxi@email.com",
    "lead_routing": "lead@email.com",
    "zillow": null
  },
  "lead_routing_email_address":"leadrouter@thisdomain.com",
  "title": "Broker",
  "bio": [
    {
      "body": "example1 example1 example1",
      "header": "example1"
    },
    {
      "body": "example2 example2 example2",
      "header": "example2"
    }
  ],
  "designations": "Realtor, CRS, SRES",
  "uuid":"8675309e9-1234-dead-beef-deadbeefdead",
  "has_engage_access":true,
  "access_level":"user",
  "teams":[
    {
      "name":"Major League Broker Team",
      "uuid":"ff083909-4acd-4c20-82f5-c993380c5717",
      "member_category":"LEAD"
    }
  ],
  "has_product_access":true,
  "website_base_url": "mymoxi@website.com",
  "twitter": "https://twitter.com/agentguy",
  "google_plus": "https://plus.google.com/1234567891011121314/posts",
  "facebook": "https://www.facebook.com/moxiworks/",
  "home_page": "foo.com",
  "profile_image_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=200",
  "profile_thumb_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=75",
  "region":"WESTERN WASHINGTON",
  "service_area_zip_codes": [
    "98117",
    "98105"
  ],
  "agent_website": {
    "base_url": "http://mymoxi@website.com",
    "bio_page_slug": "/profile/main.profile"
  },
  "company_programs": [
    "Deluxe Listings agent",
    "Very Cool Program Manager"
  ],
  "alternate_offices": [
  {
    "moxi_works_office_id": "abc123",
    "office_id": 1234,
    "office_address_street": "2636 NW Office Street",
    "office_address_street2": null,
    "office_address_city": "Altville",
    "office_address_state": "IN",
    "office_address_zip": "23232",
    "office_phone_number": "813.555.1221"
    },
      {
    "moxi_works_office_id": "xyz789",
    "office_id": 5678,
    "office_address_street": "700 123rd Ave",
    "office_address_street2": "Suite 1234",
    "office_address_city": "Nextus",
    "office_address_state": "AL",
    "office_address_zip": "99899",
    "office_phone_number": "66655544444"
    }
  ],
  "source_metadata": [
    {
      "identifier_source": "moxi",
      "identifier_type": "external_identifier",
      "identifier_key": "abc12345"
    },
    {
      "identifier_source": "moxi",
      "identifier_type": "external_identifier_alt",
      "identifier_key": "xyz99999"
    }
  ],
  gci_goal: 122131,
  buyer_commission_rate: 1.25,
  seller_commission_rate: 1.25,
  "profile_visible_online": true,
  "user_reviews": [
    {
      "source_name": "zillow",
      "agg_rating": 5,
      "reviews_count": 10
    }
  ]
}

Agent Show: Failure Response
See Error Handling for details about individual error codes.


{
  "status":"fail",
  "errorCode": xxx,
  "messages": ["messages"]
}

Show Response Attributes

Attribute	Type
moxi_works_agent_id	String
client_agent_id	String
mls_agent_id	String or null
license	String or null
mls_name	String or null
mls_abbreviation	String or null
agent_id	String
moxi_works_office_id	String
office_id	String
client_office_id	String
company_id	String
client_company_id	String
office_address_street	String or null
office_address_street2	String or null
office_address_city	String or null
office_address_state	String or null
office_address_zip	String or null
office_mailing_address_street	String or null
office_mailing_address_street2	String or null
office_mailing_address_city	String or null
office_mailing_address_state	String or null
office_mailing_address_zip	String or null
name	String or null
first_name	String or null
last_name	String or null
nickname	String or null
main_phone_number	String or null
mobile_phone_number	String or null
alt_phone_number	String or null
fax_phone_number	String or null
office_phone_number	String or null
primary_email_address	String or null
secondary_email_address	String or null
email_addresses	Hash
lead_routing_email_address	String or null
title	String or null
bio	Array
designations	String or null
uuid	String
has_product_access	Boolean
has_engage_access	Boolean
access_level	String
view_level	String
teams	Array
website_base_url	String or null
twitter	String or null
google_plus	String or null
facebook	String or null
home_page	String or null
profile_image_url	String
profile_thumb_url	String
region	String or null
gci_goal	Integer
buyer_commission_rate	Float
seller_commission_rate	Float
service_area_zip_codes	Array
agent_website	Array
alternate_offices	Array
available_mls	Array
partners	Array
company_programs	Array
source_metadata	Array
created_timestamp	Integer
deactivated_timestamp	Integer or null
profile_visible_online	Boolean
user_reviews	Array

moxi_works_agent_id This is the MoxiWorks Platform ID of the Agent. This will be a string that may take the form of an email address, or a unique alphanumeric identification string.

client_agent_id This is the ID of the Agent utilized by their company.

mls_agent_id This is the ID of the Agent utilized by their primary MLS.

license This is the number of the license granted to the agent.

mls_name This is the name of the primary MLS for the agent.

mls_abbreviation This is the standard abbreviation of the primary MLS utilized by the agent.

agent_id This is the ID of this Agent. This will be an integer.

moxi_works_office_id This is the MoxiWorks Platform ID of the office for this Agent. This will be an RFC 4122 compliant UUID.

office_id This is the ID of the office for this Agent. This will be an integer.

client_office_id This is the ID of the office for this Agent utilized by their company.

company_id This is the ID of the company for this Agent. This will be an integer.

client_company_id This is the ID of the Company utilized by their company.

office_address_street The street address of the agent’s office. This can be null if there is no data for this attribute.

office_address_street2 The suite or office number of the agent’s office. This can be null if there is no data for this attribute.

office_address_city The city the agent’s office is in. This can be null if there is no data for this attribute.

office_address_state The state or provice the agent’s office is in. This can be null if there is no data for this attribute.

office_address_zip The postal code the agent’s office is in. This can be null if there is no data for this attribute.

office_mailing_address_street The street address of the agent’s office’s mailing address. This can be null if there is no data for this attribute.

office_mailing_address_street2 The suite or office number of the agent’s office’s mailing address. This can be null if there is no data for this attribute.

office_mailing_address_city The city the agent’s office’s mailing address is in. This can be null if there is no data for this attribute.

office_mailing_address_state The state or provice the agent’s office’s mailing address is in. This can be null if there is no data for this attribute.

office_mailing_address_zip The postal code the agent’s office’s mailing address is in. This can be null if there is no data for this attribute.

name The full name of the agent. This can be null if there is no data for this attribute.

first_name The first name of the agent. This can be null if there is no data for this attribute.

last_name The last name of the agent. This can be null if there is no data for this attribute.

nickname The nickname of the agent. This can be null if there is no data for this attribute.

mobile_phone_number Mobile phone number of the agent. main_phone_number should be considered higher priority, if not the same. This can be null if there is no data for this attribute.

alt_phone_number Alternate phone number for the agent. This should be considered second in priority to main_phone_number. This can be null if there is no data for this attribute.

fax_phone_number This is the agent’s fax phone number. This can be null if there is no data for this attribute.

main_phone_number This is the agent’s main phone number. This number should be considered the number the agent would like to be contacted by. This can be null if there is no data for this attribute.

fax_phone_number This is the agent’s fax phone number. This can be null if there is no data for this attribute.

office_phone_number This is the agent’s office phone number. This can be null if there is no data for this attribute.

primary_email_address This is the agent’s main email address. This email address should be considered the email address the agent would prefer to be contacted by. This can be null if there is no data for this attribute.

secondary_email_address This is the agent’s alternate email address. This email address should be considered the email address the agent would want to be contacted by only if the address in primary_email_address is not functional. This can be null if there is no data for this attribute.

lead_routing_email_address This is the agent’s lead routing email address. This can be null if there is no data for this attribute.

title This is the business title of the agent. This can be null if there is no data for this attribute.

bio This is the bio of the agent. Array of key/value pairs. Each has a body and header, both strings, which can be null or blank.

designations This is a string that contains the agent’s designation(s), if any. This can be null if there is no data for this attribute.

uuid This is an RFC 4122 compliant UUID associated with the agent. This UUID can be used as a unique identifier in determining associations between Agent objects and Listing objects.

has_product_access Indicates whether the agent has access to MoxiWorks Products.

has_engage_access Indicates whether the agent has access to MoxiWorks Engage.

access_level The access level of the agent. If include_access_level was passed as true, this can return one of the possible access levels: company-admin, manager, office-admin, office-owner, region-admin, user.

view_level The view level of the agent. This will return one of the possible view levels: COMPANY_ADMIN, OFFICE_ADMIN, USER.

website_base_url The base url of the agent’s MoxiWorks agent website.

twitter Agent’s Twitter URL. This can be null if there is no data available for this attribute.

google_plus Agent’s Google Plus URL. This can be null if there is no data for this attribute.

facebook Agent’s Facebook page url. This can be null if there is no data for this attribute.

home_page Agent’s website domain. This will be returned without the HTTP(S) prefix. You’ll need to prefix the domain with protocol if using this attribute for an href. This can be null if there is no data for this attribute.

profile_image_url This is a valid URL for a larger size image for the agent. If no agent image has been uploaded for this agent a default image url will be provided.

profile_thumb_url This is a valid URL for a thumbnail size image for the agent. If no agent image has been uploaded for this agent a default image url will be provided.

region The region the agent’s office is in. This can be null if there is no data for this attribute.

gci_goal The agent’s stated gross commission income goal.

buyer_commission_rate Percentage commission rate for the agent when acting as a buyer’s agent.

seller_commission_rate Percentage commission rate for the agent when acting as a seller’s agent.

service_area_zip_codes A list of the lead service area zip codes covered by the agent.

agent_website This includes the base_url and bio_page_slug of the agent MoxiWorks website.

company_programs A list of the company specific program names in which the agent participates or is a member.

source_metadata A list of the source-specific user identifiers.

created_timestamp This is the Unix timestamp representing the date that this Agent was created in the MoxiWorks system.

deactivated_timestamp This is the Unix timestamp representing the date that this Agent was deactivated in the MoxiWorks system. This will be returned null if the agent is still active.

profile_visible_online Indicates the “Profile Visible Online” value in Roster for this Agent. True corresponds to Yes (visible online); false corresponds to No (not visible online).

alternate_offices Object

The alternate_offices array contains Dictionary objects representing AlternateOffice entries. The structure of each AlternateOffice entry is shown below.

Attribute	Type
moxi_works_office_id	String
office_id	Integer
office_address_street	String
office_address_street2	String
office_address_city	String
office_address_state	String
office_address_zip	String
office_phone_number	String

moxi_works_office_id This is the unique identifier for the MoxiWorks Platform AlternateOffice entry.

office_id This is an integer identifier for the MoxiWorks Platform AlternateOffice entry. If you are using MoxiWorks SSO, this will be the ID corresponding to the ID provided there.

office_address_street The street address of the office represented by this AlternateOffice entry.

office_address_street2 The second line of the street address (if required) of the office represented by this AlternateOffice entry.

office_address_city The city portion of the address of the office represented by this AlternateOffice entry.

office_address_state The state portion of the address of the office represented by this AlternateOffice entry.

office_address_zip The postal code portion of the address of the office represented by this AlternateOffice entry.

office_phone_number The phone number of the office represented by this AlternateOffice entry.

available_mls Object

The available_mls Array contains Dictionary objects representing MLS entries. The structure of each MLS entry is shown below.

Attribute	Type
name	String
display_name	String
mls_abbreviation	String
agent_id	String

name The MoxiWorks internal unique name for the MLS.

display_name The name of the MLS as it is to be displayed to users.

mls_abbreviation The abbreviation of the MLS.

agent_id The agent’s MLS id.

teams Object

The teams array contains Dictionary objects representing Team entries. The structure of each Team entry is shown below.

Attribute	Type
name	String
uuid	String
member_category	String

name This is the human readable name identifying the Team entry.

uuid This is the MoxiWorks Platform ID of the Team. This will be an RFC 4122 compliant UUID.

member_category This is the role of the agent in the team.

partners Objects

Existence of objects in the partners data structure is dependent upon external relationships existing between the agent represented by this Agent and the affiliate.

leading_re partner Objects

Attribute	Type
salesforce_id	String or null
luxury_portfolio	Boolean

salesforce_id This is the unique salesforce ID of the company in the LeadingRE system.

luxury_portfolio Indicates whether or not this agent has luxury portfolio association in the LeadingRE system.

email_addresses Object

The email_addresses Hash is a Dictionary object holding the email addresses associated with the Agent record. The structure of the object is shown below.

Attribute	Type
primary	String or null
display	String or null
alternate	String or null
moxi_sync	String or null
lead_routing	String or null
zillow	String or null

primary The primary email address associated with the Agent record.

display The display email address associated with the Agent record.

alternate The alternate email address associated with the Agent record.

moxi_sync The moxi_sync email address associated with the Agent record.

lead_routing The lead_routing email address associated with the Agent record.

zillow The zillow email address associated with the Agent record.

user_reviews Object

Existence of objects in the user_reviews data structure is dependent upon external sources, i.e. Zillow, Testimonial Tree.

user_reviews user_reviews Object

Attribute	Type
source_name	String
agg_rating	Float or null
reviews_count	Integer

source_name This is the name of the external source, i.e. zillow, testimonial_tree

agg_rating The aggregate rating to one decimal point. If reviews_count is 0 then this will be null

reviews_count This is the number of reviews found on the agent from the source

Agent Index

Ruby Search Docs

PHP Search Docs

.Net AgentService.GetAgentsAsync Docs

Agent Index Example

First page of all Agent objects for specified Company updated since a given timestamp

GET /api/agents?moxi_works_company_id=abc123&updated_since=1461108284 HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded

{
  "moxi_works_company_id":"the_company",
  "updated_since":1461108284
}


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";

var service = new AgentService(new MoxiWorksClient());
var results = service.GetAgentsAsync( "the_company",  1461108284).Result;


##### set up prerequisites once
require 'moxiworks_platform'

platform_identifier = 'abc123'

platform_secret = 'secret'

MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
##### end prerequisites

one_week =  defined?(Rails) ? 1.week : 604800
company_agents = MoxiworksPlatform::Agent.search(moxi_works_company_id: "abc123", updated_since: Time.now - one_week)

<?php
$platform_identifier = 'abc123'; // platorm_identifier provided by MoxiWorks Platform Rep
$platform_secret = 'secret'; //platform_secret provided by MoxiWorks Platform Rep

$credentials = new MoxiworksPlatform\Credentials($platform_identifier, $platform_secret);

$one_week = 604800;
$company_agents = MoxiworksPlatform\Agent::search(['moxi_works_company_id' => 'abc123', 'updated_since' => time() - $one_week]);
?>

Second page of All Agent objects for a specified Company updated since a given timestamp

GET /api/agents?moxi_works_company_id=abc123&updated_since=1461108284&page_number=2 HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded

{
  "moxi_works_company_id":"the_company",
  "updated_since":1461108284,
  "page_number":2
}


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";

var service = new AgentService(new MoxiWorksClient());
var results = service.GetAgentsAsync("some_cmpany_id",1461108284, 2).Result;

one_week =  defined?(Rails) ? 1.week : 604800
company_agents = MoxiworksPlatform::Agent.search(moxi_works_company_id: "abc123", updated_since: Time.now - one_week, page_number: 2)

<?php
$one_week = 604800;
$company_agents = MoxiworksPlatform\Agent::search(['moxi_works_company_id' => 'abc123', 'updated_since' => time() - $one_week, 'page_number' => 2]);
?>

First page of All Agent objects for a specified Office updated since a given timestamp

GET /api/agents?moxi_works_office_id=8c3f446c-aab9-11e6-9a0f-d0e1408e8026&moxi_works_company_id=abc123&updated_since=1461108284 HTTP/1.1
Host: api.moxiworks.com
Accept: application/vnd.moxi-platform+json;version=1
Authorization: Basic XNNeXAAAUZaQlF0dA==
Content-Type: application/x-www-form-urlencoded

{
  "moxi_works_company_id":"the_company",
  "moxi_works_office_id":"8c3f446c-aab9-11e6-9a0f-d0e1408e8026",
  "updated_since":1461108284
}


/* set up prerequisites once */
ConfigurationManager.AppSettings["Secret"] = "secret";
ConfigurationManager.AppSettings["Identifier"] = "abc123";

var service = new AgentService(new MoxiWorksClient());
var results = service.GetAgentsAsync("some_company_id", 1461108284, "some_office_id").Result;

one_week =  defined?(Rails) ? 1.week : 604800
company_agents = MoxiworksPlatform::Agent.search(moxi_works_company_id: "abc123", updated_since: Time.now - one_week, moxi_works_office_id: "8c3f446c-aab9-11e6-9a0f-d0e1408e8026")

<?php
$one_week = 604800;
$company_agents = MoxiworksPlatform\Agent::search(['moxi_works_company_id' => 'abc123', 'updated_since' => time() - $one_week, 'moxi_works_office_id' => '8c3f446c-aab9-11e6-9a0f-d0e1408e8026']);
?>

Agent Index Request Attributes

When searching for Agent entities using the MoxiWorks platform API, format your data using the following parameters.

Attribute	Type	Length Limit
moxi_works_company_id	String	255
parent_company_id	String	255
moxi_works_office_id	String	255
updated_since	Integer	255
page_number	Integer	255
include_access_level	Boolean	255
deactivated	Boolean	255
deactivated_since	Integer	255
include_partners	Boolean	255
include_company_programs	Boolean	255
include_website	Boolean	255
has_company_programs	Boolean	255
include_reviews	Boolean	255
timestamps_only	Boolean	255

Required Parameters Are In Red

moxi_works_company_id A valid MoxiWorks Company ID. Use Company Endpoint to determine what moxi_works_company_id you can use.

moxi_works_office_id A valid MoxiWorks Office ID. Use Office Endpoint to determine what moxi_works_office_id you can use.

updated_since any Agent objects updated after this Unix timestamp will be returned in the response. If no updated_since parameter is included in the request, only Agent objects updated in the last seven days will be returned.

page_number For queries with multi-page responses, use the page_number parameter to return data for specific pages. Data for page 1 is returned if this parameter is not included. Use this parameter if total_pages indicates that there is more than one page of data available.

include_access_level To include access level information for the agent in the response, pass true

deactivated To find Agent accounts deactivated within the specified timeframe, pass true for this boolean parameter.

deactivated_since any Agent objects deactivated after this Unix timestamp will be returned in the response. If no deactivated_since parameter is included in the request, only Agent objects deactivated in the last seven days will be returned.

include_partners To include affiliate data associated with the agent in the response, pass true.

include_company_programs To include company specific programs associated with the agent in the response, pass true.

include_website To include the base url (website_base_url) of the agent’s MoxiWorks website pass true.

has_company_programs To include only Agent objects associated with company specific programs pass true.

include_reviews To include ratings and reviews associated with the agent in the response, pass true.

timestamps_only If supplied then the results will exclude all data except primary identifiers and a unix timestamp (last_updated) & iso8601 timestamp (modification_timestamp) of the last time this record was updated.

Agent Index: Success Response


{
"page_number":9,
"total_pages":9,
"agents":[
{
  "moxi_works_agent_id": "abc123",
  "client_agent_id":"abc123",
  "mls_agent_id":"MLS_ID",
  "license":"abc123lic",
  "mls_name":"Bob's Better MLS",
  "mls_abbreviation":"BBM",
  "moxi_works_office_id":"8c3f446c-aab9-11e6-9a0f-d0e1408e8026",
  "office_id":"1234",
  "client_office_id":"987123",
  "company_id":"2345",
  "client_company_id":"abc392",
  "agent_id":"67890",
  "office_address_street":"3456 Office Ln.",
  "office_address_street2":"Suite 1234",
  "office_address_city": "Officeville",
  "office_address_state": "AG",
  "office_address_zip": "12345",
  "office_mailing_address_street": "1236 Mailbox Ave.",
  "office_mailing_address_street2":"Box 43",
  "office_mailing_address_city": "Mailtown",
  "office_mailing_address_state": "AG",
  "office_mailing_address_zip": "12348",
  "name": "Buckminster Fuller",
  "first_name":"Buckminster",
  "last_name":"Fuller",
  "main_phone_number": "555) 9101112",
  "mobile_phone_number": "555 333 4567",
  "alt_phone_number": "(555) 567-8910",
  "fax_phone_number": "5557891011",
  "office_phone_number": "(234)456-7890",
  "primary_email_address": "the_agent@agentdomain.com",
  "secondary_email_address": "the_agent_alt@otherdomain.com",
  "email_addresses": {
    "primary": "primary@email.com",
    "display": "display@email.com",
    "alternate": null,
    "moxi_sync": "moxi@email.com",
    "lead_routing": "lead@email.com",
    "zillow": null
  },
  "lead_routing_email_address":"leadrouter@thisdomain.com",
  "title": "Broker",
  "bio": [
    {
      "body": "example1 example1 example1",
      "header": "example1"
    },
    {
      "body": "example2 example2 example2",
      "header": "example2"
    }
  ],
  "designations": "Realtor, CRS, SRES",
  "uuid":"8675309e9-1234-dead-beef-deadbeefdead",
  "has_product_access":true,
  "has_engage_access":true,
  "access_level":"user",
  "view_level": "COMPANY_ADMIN",
  "teams":[
    {
      "name":"Major League Broker Team",
      "uuid":"ff083909-4acd-4c20-82f5-c993380c5717",
      "member_category":"LEAD"
    }
  ],
  "website_base_url": "mymoxi@website.com",
  "twitter": "https://twitter.com/agentguy",
  "google_plus": "https://plus.google.com/1234567891011121314/posts",
  "facebook": "https://www.facebook.com/moxiworks/",
  "home_page": "foo.com",
  "profile_image_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=200",
  "profile_thumb_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=75",
  "region":"WESTERN WASHINGTON",
  "service_area_zip_codes": [
    "98117",
    "98105"
  ],
  "agent_website": {
    "base_url": "http://mymoxi@website.com",
    "bio_page_slug": "/profile/main.profile"
  },
  "company_programs": [
    "Deluxe Listings agent",
    "Very Cool Program Manager"
  ],
  "alternate_offices": [
  {
    "moxi_works_office_id": "abc123",
    "office_id": 1234,
    "office_address_street": "2636 NW Office Street",
    "office_address_street2": null,
    "office_address_city": "Altville",
    "office_address_state": "IN",
    "office_address_zip": "23232",
    "office_phone_number": "813.555.1221"
    },
      {
    "moxi_works_office_id": "xyz789",
    "office_id": 5678,
    "office_address_street": "700 123rd Ave",
    "office_address_street2": "Suite 1234",
    "office_address_city": "Nextus",
    "office_address_state": "AL",
    "office_address_zip": "99899",
    "office_phone_number": "66655544444"
    }
  ],
  "source_metadata": [
    {
      "identifier_source": "moxi",
      "identifier_type": "external_identifier",
      "identifier_key": "abc12345"
    },
    {
      "identifier_source": "moxi",
      "identifier_type": "external_identifier_alt",
      "identifier_key": "xyz99999"
    }
  ],
  "profile_visible_online": true,
  "user_reviews": [
    {
      "source_name": "zillow",
      "agg_rating": 5,
      "reviews_count": 10
    }
  ]
}
]
}

Agent Index: Failure Response
See Error Handling for details about individual error codes.

{
  "status":"fail",
  "errorCode": xxx,
  "messages": ["messages"]
}

Agent Index responses are divided into pages of Agent objects. Use response payload attributes total_pages and page_number to determine how many pages of Agent objects there are and whether additional pages need to be requested.

Attribute	Type
page_number	Integer
total_pages	Integer
agents	Array

agents Object

The agents array contains Dictionary objects representing Agent entries. The structure of each Agent entry is shown below.

Attribute	Type
moxi_works_agent_id	String
client_agent_id	String
mls_agent_id	String or null
license	String or null
mls_name	String or null
mls_abbreviation	String or null
agent_id	String
moxi_works_office_id	String
office_id	String
client_office_id	String
company_id	String
client_company_id	String
office_address_street	String or null
office_address_street2	String or null
office_address_city	String or null
office_address_state	String or null
office_address_zip	String or null
office_mailing_address_street	String or null
office_mailing_address_street2	String or null
office_mailing_address_city	String or null
office_mailing_address_state	String or null
office_mailing_address_zip	String or null
name	String or null
first_name	String or null
last_name	String or null
nickname	String or null
main_phone_number	String or null
mobile_phone_number	String or null
alt_phone_number	String or null
fax_phone_number	String or null
office_phone_number	String or null
primary_email_address	String or null
secondary_email_address	String or null
email_addresses	Hash
lead_routing_email_address	String or null
title	String or null
bio	Array
designations	String or null
uuid	String
has_product_access	Boolean
has_engage_access	Boolean
access_level	String
view_level	String
teams	Array
website_base_url	String or null
twitter	String or null
google_plus	String or null
facebook	String or null
home_page	String or null
profile_image_url	String
profile_thumb_url	String
region	String or null
service_area_zip_codes	Array
agent_website	Array
alternate_offices	Array
available_mls	Array
partners	Array
company_programs	Array
source_metadata	Array
created_timestamp	Integer
deactivated_timestamp	Integer or null
profile_visible_online	Boolean
user_reviews	Array