listings

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

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.

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.

This is the MoxiWorks Platform ID of the Agent which Listing objects are associated with. This will be an RFC 4122 compliant UUID.

Use this parameter when searching for Listing objects associated with a specific Agent. This will be a string that may take the form of an email address, or a unique identification string. This data must reference a valid MoxiWorks Agent ID for your Listing Index request to be accepted.

A company’s internal agent id may be used to construct the agent’s unique identification string. To do so, the value passed via the moxi_works_agent_id should be a single concatenated string, of the form: [moxi_works_company_id]:[internal_agent_id] Use Company Endpoint to determine which moxi_works_company_id to use.

Use this parameter when searching for Listing objects associated with a specific Office. This data must reference a valid MoxiWorks Office ID for your Listing Index request to be accepted.

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

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.

When filtering by market_status use one of the following options:

Value Description on-market The default value for market_status. This listing set includes ‘Active,’ ‘Pending’ and ‘Contingent’ listings. off-market If market_status is set to this value, only off-market listings will be returned. all When market_status is set to this value, both off-market and on-market listings will be returned.

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.

Use this legend to determine which integer values to include in property_types.

Number Property Type -1 Not Found 1 Residential 2 Condo 3 Land 4 Mfghome 5 Farm/Ranch 6 Rental 7 Multifamily 8 Co-op 9 Townhouse 10 Commerical 11 Business Opportunity 12 Commercial Res Income 13 Commercial Hotel 14 Commercial Mobile Home Park 15 Commercial Lease 16 Commercial Land 17 Moorage 18 Timeshare 19 Commercial Industrial 20 Multifamily2_4 21 Multifamily5up 22 Apartment 23 Highrise

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

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

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.

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.