Product Associations

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

LotSizeAcres

General Info: This is the property size of the listing land in acres.

Roster Image Roster

moxi_works_office_id

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

API Image API
Roster Image Roster

ListingID

General Info: The MLS number for the listing.

Roster Image Roster

MoxiWorksListingId

General Info: The unique Identifier for the listing in The MoxiWorks Platform.

API Image API

AgentCreatedListing

General Info: Whether the agent created this listing.

API Image API

VirtualTourURL

General Info: Virtual tour URL for this listing.

Roster Image Roster

TaxParcelId

General Info: The Tax ID / Parcel ID for the property. If no data is available for this attribute, it will be null.

Roster Image Roster

OpenHouse

General Info: Open house data.

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

updated_since

Listing Info: Paged responses of all Listing objects updated after this Unix timestamp will be returned in the response. If no updated_since parameter is included in the request, only Listing objects updated in the last seven days will be returned.
API Image API

ListOfficeAOR

General Info: The name of the MLS which this listing is listed with.

Roster Image Roster

ListingImages

General Info: Any images in the gallery. [see, documentation]

Roster Image Roster

moxi_works_listing_id

General Info: This is the MoxiWorks Platform ID of the Listing which you are requesting to Update. This data is required and must reference a valid MoxiWorks Listing ID for your Update request to be accepted.

Roster Image Roster

underscore_response

General Info: When this attribute is passed as true, the json keys of the response will be underscored. The default json key format for listing responses is camel casing.

API Image API

BathroomsFull

General Info: This is the number of full bathrooms in the property.

Roster Image Roster

BathroomsHalf

General Info: This is the number of half bathrooms in the property.

Roster Image Roster

BathroomsOneQuarter

General Info: This is the number of quarter-sized bathrooms in the property.

Roster Image Roster

BathroomsPartial

General Info: This is the number of partial bathrooms in the property.

Roster Image Roster

BathroomsThreeQuarter

General Info: This is the number of three-quarter bathrooms in the property.

Roster Image Roster

BathroomsTotalInteger

General Info: This is the number of rooms that are bathrooms in the property. This is not a summary count of bathrooms by size.

Roster Image Roster

BathroomsTotal

General Info: This is the summary count of bathrooms in the property. This will be the number of quarter-bathrooms plus half-bathrooms plus three-quarter bathrooms plus full bathrooms.

Roster Image Roster

BedroomsTotal

General Info: This is the number of bedrooms in the property.

Roster Image Roster

PublicTitle

General Info: The human-readable title for the listing generated by the property agent.

Roster Image Roster

PublicRemarks

General Info: These are human-readable notes about the property generated by the property agent.

Roster Image Roster

ModificationTimestamp

General Info: This is a string representing a date on which the listing data was last updated in ISO 8601 format.

API Image API

StatusChangeDate

Listing Info: Date the listing status changed to its current value.
API Image API

InternetAddressDisplayYN

General Info: This denotes whether the property should be displayed on a public facing website.

API Image API

DaysOnMarket

General Info: The number of days the listing has been on market.

Roster Image Roster

ListingContractDate

General Info: This is a string representing a date on which the listing contract was initiated. The string format is MM/DD/YYYY.

Roster Image Roster

CreatedDate

General Info: This is a string representing a date on which the Listing object was created. The string format is MM/DD/YYYY.

API Image API

ElementarySchool

General Info: The elementary school for the property.

Roster Image Roster

GarageSpaces

General Info: The number of garage spaces that are available at the property.

Roster Image Roster

WaterfrontYN

General Info: Whether the property is waterfront.

Roster Image Roster

HighSchool

General Info: The high school for the property.

Roster Image Roster

AssociationFee

General Info: The home owner’s association fee for the property.

Roster Image Roster

ListOfficeName

General Info: The name of the listing office.

Roster Image Roster

ListPrice

General Info: The listed price for the listing.

Roster Image Roster

ListAgentFullName

General Info: The name of the listing agent.

Roster Image Roster

ListAgentUUID

General Info: A unique identifier for the listing agent. This will correspond to the uuid field of an Agent.

Roster Image Roster

ListAgentOfficeID

General Info: A unique identifier for the listing agent’s office. This will correspond to the office_id field of an Office.

Roster Image Roster

ListAgentMoxiWorksOfficeID

General Info: A unique identifier for the listing agent’s office. This will correspond to the moxi_works_office_id field of an Office.

Roster Image Roster

SecondaryListAgentFullName

General Info: If there is a second listing agent, the name of the second listing agent.

Roster Image Roster

SecondaryListAgentUUID

General Info: If there is a second listing agent, the unique identifier for the second listing agent. This will correspond to the uuid field of an Agent.

Roster Image Roster

SchoolDistrict

General Info: The school district the listing property is in.

Roster Image Roster

Address

General Info: The street address of the property.

Roster Image Roster

Address2

General Info: Additional street address information, for example, suite number.

Roster Image Roster

City

General Info: City or township the property is located in.

Roster Image Roster

CountyOrParish

General Info: County or Parish that the property is located in.

Roster Image Roster

Latitude

General Info: The latitude of the property.

Roster Image Roster

Longitude

General Info: The longitude of the property.

Roster Image Roster

StateOrProvince

General Info: State or province the property is located in.

Roster Image Roster

PostalCode

General Info: The zip code or postal code the property is located in.

Roster Image Roster

Community

General Info: The community the property is located in.

Roster Image Roster

LotSizeSquareFeet

General Info: Total area of the lot.

Roster Image Roster

InternetEntireListingDisplayYN

General Info: Whether to display information about this listing publicly. If this is false, then the information about this listing should not be visible to the Internet.

API Image API

MiddleOrJuniorSchool

General Info: The middle school for the property.

Roster Image Roster

ListOfficeAORArea

General Info: The MLS Area which this listing is in.

Roster Image Roster

PoolYN

General Info: Whether the property has a pool.

Roster Image Roster

PropertyType

General Info: The type of property being listed. This can be one of Residential, Condo-Coop, Townhouse, Land, Multifamily.

Roster Image Roster

TaxAnnualAmount

General Info: The total annual property tax.

Roster Image Roster

TaxYear

General Info: The tax year that the property tax in TaxAnnualAmount was assessed.

Roster Image Roster

SingleStory

General Info: Whether the building has one story or is multi-story.

Roster Image Roster

LivingArea

General Info: Total square footage of the building(s) on the property.

Roster Image Roster

ViewYN

General Info: Whether the property has a view.

Roster Image Roster

YearBuilt

General Info: The year the living building(s) on the property were built.

Roster Image Roster

OnMarket

General Info: Whether the listing is currently on-market.

Roster Image Roster

Status

General Info: Detailed status of the listing; whether it’s sold | expired | sale | fail | temp off market | other | canceled | pending | contingent unknown | coming | soon

Roster Image Roster

SharedPartnerData

General Info: A hash containing data shared between MoxiWorks affiliates.

API Image API

ListingURL

General Info: Details URL for this listing.

Roster Image Roster
Websites Image Websites

PropertyFeatures

General Info: Any defined features about the property.

Roster Image Roster

CompanyListingAttributes

General Info: Company specific attributes associated with the listing. These will be defined by the company & should not be expected to be uniform across companies.

API Image API

ImagesLastModified

General Info: The date when the images of the property were last modified, or null if the property has no images.

API Image API

BuyerCommissionType

General Info: The type of buyer broker compensation value set for the listing. The two types of broker compensation values are percent or flat_rate.

Roster Image Roster

BuyerCommissionValue

General Info: Buyer broker compensation value for the listing.

Roster Image Roster

last_moxi_works_listing_id

General Info: If fetching a multi-page response, this should be the MoxiWorksListingId found in the last Listing object of the previously fetched page.

API Image API

shared_partner_data_updated_since

General Info: Include additional listings using this unix timestamp representing the date since partner data has been updated. This attribute should be used in conjuncion with the updated_since attribute.

API Image API

market_status

General Info: When filtering by market_status use one of the following options: [on-market, off-market, all]

API Image API

property_types

General Info: When filtering by property_types pass a comma separated string of integers associated with various property types. When property_types is not inlcuded, all property types will be included in the response. See documentation for legend.

API Image API

only_agent_created

General Info: When this filter parameter is passed as true, the response will be restricted to listings created by agents (non-mls listings).

API Image API

coming_soon

General Info: When this attribute is passed as true only listings with status “ComingSoon” will be returned.

Roster Image Roster

FinalPage

General Info: If there is another page of Listing objects available, this will be false. If you are receiving the final page of Listing objects for the query, FinalPage will be true.

API Image API

Listings

General Info: Each object in the Listings array will have the structure as defined in the documentation.

API Image API