Product Associations

moxi_works_contact_id

General Info: This will be an RFC 4122 compliant UUID, and is the same as the moxi_works_contact_id attribute of the Contact response.

Engage Image Engage

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

transaction_name

BuyerTransaction Info: For Buyer Transactions, this will be the name or title of the transaction in question.
Engage Image Engage

notes

BuyerTransaction Info: For Buyer Transactions, these will be the related notes.
Engage Image Engage

address

BuyerTransaction Info: In relation to a Buyer Transaction, this is the street address of the property being purchased.
Engage Image Engage

partner_contact_id

General Info: This is the unique identifer used in the system that will be connecting to the MoxiWorks platform.

API Image API

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

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

city

BuyerTransaction Info: In relation to a Buyer Transaction, this will be the city or township of the property being purchased.
Engage Image Engage

state

BuyerTransaction Info: In relation to a Buyer Transaction, this will be the state or province of the property being purchased.
Engage Image Engage

zip_code

BuyerTransaction Info: In relation to a Buyer Transaction, this will be the postal code of the property being purchased.
Engage Image Engage

min_sqft

BuyerTransaction Info: In relation to a Buyer Transaction, the minimum desired living area for prospective properties.
Engage Image Engage

max_sqft

BuyerTransaction Info: In relation to a Buyer Transaction, the maximum desired living area for prospective properties.
Engage Image Engage

min_beds

BuyerTransaction Info: In relation to a Buyer Transaction, the minimum number of bedrooms for prospective properties.
Engage Image Engage

max_beds

BuyerTransaction Info: In relation to a Buyer Transaction, the maximum number of bedrooms for prospective properties.
Engage Image Engage

min_baths

BuyerTransaction Info: In relation to a Buyer Transaction, the minimum number of bathrooms for prospective properties.
Engage Image Engage

max_baths

BuyerTransaction Info: In relation to a Buyer Transaction, the maximum number of bathrooms for prospective properties.
Engage Image Engage

area_of_interest

BuyerTransaction Info: In relation to a Buyer Transaction, the name of a locality representing an area of interest for prospective properties.
Engage Image Engage

is_mls_transaction

BuyerTransaction Info: In relation to a Buyer Transaction, this attribute indictates whether the property being purchased is listed on an MLS.
Engage Image Engage

mls_number

BuyerTransaction Info: In relation to a Buyer Transaction, the MLS number of the the property being purchased.
Engage Image Engage

start_timestamp

BuyerTransaction Info: In relation to a Buyer Transaction, this would be considered the date and time when the agent first initiated transaction discussions with the client.
Engage Image Engage

commission_percentage

BuyerTransaction Info: In relation to a Buyer Transaction, the total commission for the transaction based on this percentage of the purchase price.
Engage Image Engage

commission_flat_fee

BuyerTransaction Info: In relation to a Buyer Transaction, this is the dollar amount of the total commission for the transaction.
Engage Image Engage

sales_volume_percentage

BuyerTransaction Info: In relation to a Buyer Transaction, the total commission for the transaction based on sales volume percentage.
Engage Image Engage

sales_volume_flat_fee

BuyerTransaction Info: In relation to a Buyer Transaction, the total commission for the transaction based on percentage of purchase price.
Engage Image Engage

target_price

BuyerTransaction Info: The desired purchase price for a property if using target rather than range.
Engage Image Engage

min_price

BuyerTransaction Info: The minimum price range for a property if using a price range rather than target price.
Engage Image Engage

max_price

BuyerTransaction Info: The maximum price range for a property if using a price range rather than target price.
Engage Image Engage

stage

General Info: The stage that the Transaction should be placed into.

API Image API

moxi_works_transaction_id

General Info: This is the MoxiWorks Platform ID of the Transaction which you have created. This will be an RFC 4122 compliant UUID. This ID should be recorded on response as it is the key ID for updating the Transaction.

API Image API

stage_name

General Info: This attribute displays the name or title that is associated with the current stage of the transaction.

Engage Image Engage

closing_price

General Info: This is the closing price for the transaction.

Engage Image Engage

closing_timestamp

BuyerTransaction Info: For a Buyer Transaction, this represents the point in time when the transaction was completed.
Engage Image Engage

state_changed_at

BuyerTransaction Info: A Unix timestamp representing the point in time when the transaction for this BuyerTransaction object entered into its current state.
API Image API

promote_transaction

General Info: If this is set to true then The MoxiWorks Platform will promote this transaction to the next stage.

API Image API