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

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

notes

SellerTransaction Info: For Seller Transactions, these will be the related notes.
Engage Image Engage

address

SellerTransaction 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.

Roster Image Roster

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

SellerTransaction Info: In relation to a Seller Transaction, this will be the city or township of the property being sold.
Engage Image Engage

state

SellerTransaction Info: In relation to a Seller Transaction, this will be the state of the property being sold.
Engage Image Engage

zip_code

SellerTransaction Info: In relation to a Seller Transaction, this will be the zip code of the property being sold.
Engage Image Engage

is_mls_transaction

SellerTransaction Info: In relation to a Seller Transaction, this attribute indictates whether the property being sold is listed on an MLS.
Engage Image Engage

mls_number

SellerTransaction Info: In relation to a Seller Transaction, the MLS number of the the property being sold.
Engage Image Engage

start_timestamp

SellerTransaction Info: For non-MLS transactions, this is the Unix timestamp representing the date that the agent initiated transaction discussions with the client. This should be null if the SellerTransaction is an MLS sale.
Engage Image Engage

commission_percentage

SellerTransaction Info: If the agent is to receive commission based on percentage of purchase price for the transaction associated with this SellerTransaction, then this will represent the commission that the agent is to receive.
Engage Image Engage

commission_flat_fee

SellerTransaction Info: If the agent is to receive a flat-rate commission for the transaction associated with this SellerTransaction, then this will represent the commission that the agent is to receive.
Engage Image Engage

sales_volume_percentage

SellerTransaction Info: If the agent is to receive compensation based on percentage of sales volume, then this will represent the percentage that the agent is to receive.
Engage Image Engage

sales_volume_flat_fee

SellerTransaction Info: If the agent is to receive a flat-rate compensation based on sales volume, then this will represent the compensation that the agent is to receive.
Engage Image Engage

target_price

SellerTransaction Info: The desired selling price for the property if using target rather than range.
Engage Image Engage

min_price

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

max_price

SellerTransaction Info: The maximum price range for the 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

SellerTransaction Info: A Unix timestamp representing the point in time when the transaction for this SellerTransaction object was completed.
Engage Image Engage

state_changed_at

SellerTransaction Info: A Unix timestamp representing the point in time when the transaction for this SellerTransaction 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

total_pages

SellerTransaction Info: If there is more than one page of SellerTransaction objects to return, total_pages will denote how many pages of SellerTransaction objects there are to be returned fo the current query. Subsequent pages can be returned by including the page_number parameter in your API request.
API Image API

beds

SellerTransaction Info: The number of bedrooms in the property being sold.
Engage Image Engage

baths

SellerTransaction Info: The number of bathrooms in the property being sold.
Engage Image Engage

sqft

SellerTransaction Info: The living area of the property being sold.
Engage Image Engage

transactions

SellerTransaction Info: This array contains the payload from the request query. Any found SellerTransaction objects matching the query will be returned as SellerTransaction objects in the response. [see, documentation]
API Image API
Engage Image Engage