Product Associations

title

General Info: This represents the title of the entity this attribute is associated with.

Roster Image Roster

office_id

General Info: This is the MoxiWorks Platform ID of the office for the agent. This will be an RFC 4122 compliant UUID.

API Image API
Roster Image Roster

bio

Agent Info: This is the bio of the agent, as seen on the about me > web info page.
Roster Image Roster

designations

Agent Info: This is a string that contains the agent’s designation(s), if any.
Roster Image Roster

has_product_access

Agent Info: Referring to each individual Moxi product offered, such as Engage, Present, Impress etc.
Roster Image Roster

has_engage_access

Agent Info: Referencing the agent’s ability to access Engage as a product.
Roster Image Roster
Engage Image Engage

access_level

Agent Info: Related to the products and permissions page, specific to user account permissions section.
Roster Image Roster

view_level

Agent Info: The view level of the agent.
Roster Image Roster

available_mls

Agent Info: The available_mls Array contains Dictionary objects representing MLS entries. These include [name, display_name, mls_abbreviation, agent_id].
Roster Image Roster

source_metadata

Agent Info: A list of the source-specific user identifiers.
API Image API

profile_visible_online

Agent Info: Indicates the “Profile Visible Online” value for this agent within Roster. True corresponds to Yes (visible online); false corresponds to No (not visible online).
Roster Image Roster

user_reviews

Agent Info: This relates to external agent reviews from platforms such as Zillow and Testimonial Tree. Existence of objects in the user_reviews data structure is dependent upon external sources, i.e. Zillow, Testimonial Tree. Documented entities in the `user_reviews` data structure may or may not be returned when `include_reviews=true` is passed. Your logic should be engineered to handle cases where the entity you are interested in is returned and where an empty data structure is returned. Included in this - [source_name, agg_rating, reviews_count]
API Image API
Roster Image Roster

include_company_programs

Agent Info: To include company specific programs associated with the agent in the response, pass true.
API Image API

include_website

Agent Info: To include the base url (website_base_url) of the agent’s MoxiWorks website pass true.
API Image API
Websites Image Websites

partners

Agent Info: Existence of objects in the partners data structure is dependent upon external relationships existing between the agent represented by this agent and the affiliate. Documented entities in the `partners` data structure may or may not be returned based on agent relationship. Your logic should be engineered to handle cases where the entity you are interested in is returned and where an empty data structure is returned.
API Image API

license

Agent Info: This is the number of the license granted to the agent. Please see mls_agent_id for the actual agent MLS ID value, as utilized by the Moxi platform to associate listings and other related data in most instances.
API Image API

mls_name

Agent Info: This is the name of the primary MLS for the agent.
Roster Image Roster

mls_abbreviation

Agent Info: This name can be found on the Manage MLS Associations page of the agent or other User Account.
Roster Image Roster

agent_id

Agent Info: This is the ID of this agent. This will be an integer.
API Image API

client_office_id

Agent Info: This is the ID of the office for the agent. This will be an integer.
API Image API

twitter

Agent Info: agent’s Twitter URL. Seen within About Me > Web Info.
Roster Image Roster

google_plus

General Info: This will be null. Deprecated field related to a product that no longer exists, offered by Google many moons ago.

Roster Image Roster

facebook

Agent Info: agent’s Facebook page url. Seen within About Me > Web Info.
Roster Image Roster

region

General Info: The region the office is in.

Roster Image Roster

company_programs

Agent Info: A list of the company specific program names in which the agent participates or is a member.
API Image API

created_timestamp

Agent Info: This is the Unix timestamp representing the date that this agent was created in the MoxiWorks system.
API Image API
Roster Image Roster

deactivated_timestamp

Agent Info: 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.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.
API Image API
Roster Image Roster

timestamps_only

General Info: 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.

API Image API

moxi_works_office_id

General Info: This will be an RFC 4122 compliant UUID.

API Image API
Roster Image Roster

agent_uuid

General Info: This will be an RFC 4122 compliant UUID. If data is being pulled 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.

Roster Image Roster

moxi_works_agent_id

General Info: 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. It is intended for use cases where integration is managed by end-user interaction.

API Image API

source_agent_id

General Info: 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.

API Image API

moxi_works_company_id

General Info: MoxiWorks Plaform Company entities are your entry-point for determining the established relationships for your organization to companies on the MoxiWorks Platform and for accessing data about those companies. Many requests require a moxi_works_company_id, which can be derived from the Company Index endpoint.

API Image API
Roster Image Roster

parent_company_id

General Info: This 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. It also 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.

API Image API
Roster Image Roster

include_access_level

Agent Info: The access level of the agent. This can return one of the possible access levels, as seen within the products and permissions page. To include access level information for the agent in the response, pass true.
API Image API
Roster Image Roster

include_gci_goals

Agent Info: This represents the Gross Commission Income goal, as seen throughout the Engage UI. This attribute will include agent’s GCI goals and commissions data in the response data if true is passed.
API Image API
Engage Image Engage

include_partners

Agent Info: To include affiliate data associated with the agent in the response, pass true.
API Image API

include_reviews

Agent Info: Referencing external agent reviews from platforms such as Zillow and Testimonial Tree. To include ratings and reviews associated with the agent in the response, pass true.
API Image API
Roster Image Roster

client_agent_id

Agent Info: This is the ID of the agent, as utilized by their brokerage or company.
API Image API

mls_agent_id

Agent Info: This is the ID of the agent utilized by their primary MLS. This ID allows listings to associate with the User Account. This ID can be found on the Manage MLS Associations page of the agent or other User Account.
Roster Image Roster

company_id

Agent Info: This is the ID of the company for the agent. This will be an integer.
API Image API

client_company_id

Agent Info: This is the ID of the Company utilized by their brokerage or company. This is a client-specified identifier of the company which this Company object represents, or null if absent.
API Image API

office_address_street

General Info: This is the main associated physical street address where the office is located.

Roster Image Roster

office_address_street2

General Info: This is the main associated secondary physical street address field, often populated with a suite or office number.

Roster Image Roster

office_address_city

General Info: The city where the office is located, as associated with the physical address.

Roster Image Roster

office_address_state

General Info: The state where the office is located, as associated with the physical address.

Roster Image Roster

office_address_zip

General Info: The postal code associated with the office physical address.

Roster Image Roster

office_mailing_address_street

General Info: This is the associated mailing address where the office is located.

Roster Image Roster

office_mailing_address_street2

General Info: This is the associated secondary mailing street address field, often populated with a suite or office number.

Roster Image Roster

office_mailing_address_city

General Info: The city where the office receives mail, as associated with the mailing address.

Roster Image Roster

office_mailing_address_state

General Info: The state where the office receives mail, as associated with the mailing address.

Roster Image Roster

office_mailing_address_zip

General Info: The postal code associated with the office mailing address.

Roster Image Roster

name

General Info: This name attribute is shared between several endpoints, and generally represents the full name of the entity.

Roster Image Roster

first_name

Agent Info: The first name of the agent.
Roster Image Roster

last_name

Agent Info: The last name of the agent.
Roster Image Roster

nickname

Agent Info: The nickname of the agent.
Roster Image Roster

main_phone_number

Agent Info: This is the agent’s main phone number. This number should be considered the number the agent would like to be contacted by.
Roster Image Roster

mobile_phone_number

Agent Info: Mobile phone number of the agent. main_phone_number should be considered higher priority, if not the same.
Roster Image Roster

alt_phone_number

Agent Info: Alternate phone number for the agent. This should be considered second in priority to main_phone_number.
Roster Image Roster

fax_phone_number

Agent Info: This is the agent’s fax phone number.
Roster Image Roster

office_phone_number

Agent Info: This is the agent’s office phone number.
Roster Image Roster

primary_email_address

Agent Info: 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.
Roster Image Roster

secondary_email_address

Agent Info: 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.
Roster Image Roster

email_addresses

Agent Info: The email_addresses Hash is a Dictionary object holding the email addresses associated with the agent record. These include [primary, display, alternate, moxi_sync, lead_routing, zillow]. Some of these will display on the About Me section of Roster, including primary, display, moxi sync.
Roster Image Roster

lead_routing_email_address

Agent Info: This is the agent’s lead routing email address.
API Image API
Roster Image Roster

uuid

Agent Info: This is an RFC 4122 compliant UUID. This UUID can be used as a unique identifier in determining associations between agent objects and Listing objects.
Roster Image Roster

teams

Agent Info: Related to agent Teams, within My Account section.
Roster Image Roster

website_base_url

Agent Info: The base url of the agent’s MoxiWorks agent website.
Roster Image Roster
Websites Image Websites

home_page

Agent Info: agent’s website domain. This will be returned without the HTTP(S) prefix.
Roster Image Roster
Websites Image Websites

profile_image_url

Agent Info: agent’s associated profile image within About Me section.
Roster Image Roster

profile_thumb_url

Agent Info: agent’s associated profile image within About Me section, thumbnail.
Roster Image Roster

gci_goal

Agent Info: This is the agent’s Gross Commission Income goal, as seen throughout the Engage UI.
Engage Image Engage

buyer_commission_rate

Agent Info: Percentage commission rate for the agent when acting as a buyer’s agent.
Roster Image Roster

seller_commission_rate

Agent Info: Percentage commission rate for the agent when acting as a seller’s agent.
Roster Image Roster

service_area_zip_codes

Agent Info: A list of the lead service area zip codes covered by the agent.
Roster Image Roster

agent_website

Agent Info: This includes the base_url and bio_page_slug of the agent MoxiWorks website.
Websites Image Websites

alternate_offices

Agent Info: agent’s alternate offices, as seen within the additional offices page. The alternate_offices array contains Dictionary objects representing AlternateOffice entries. These include [moxi_works_office_id, office_id, office_address_street, office_address_street2, office_address_city, office_address_state, office_address_zip, office_phone_number].
Roster Image Roster

updated_since

Agent Info: Any agent objects updated after this Unix timestamp will be returned in the response. If no updated_since parameter is included in the request, by default only agent objects updated in the last seven days will be returned.
API Image API

page_number

General Info: 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.

API Image API

deactivated

Agent Info: To find agent accounts deactivated within the specified timeframe, pass true for this boolean parameter.
API Image API

deactivated_since

Agent Info: 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.
API Image API

has_company_programs

Agent Info: To include only agent objects associated with company specific programs pass true.
API Image API

include_bio

Agent Info: This references the bio of the agent, as seen on the about me > web info page. To include the bio associated with the agent in the response, pass true.
API Image API