agents

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

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.

any Agent objects updated after this Unix timestamp will be returned in the response. If no updated_since parameter is included in the request, only Agent objects updated in the last seven days will be returned.

By default only Agent objects updated in the last seven days will be returned.

To find Agent accounts deactivated within the specified timeframe, pass true for this boolean parameter.

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.

By default only Agent objects deactivated in the last seven days will be returned.

To include access level information for the agent in the response, pass true

To include company specific programs associated with the agent in the response, pass true.

To include affiliate data associated with the agent in the response, pass true.

To include the base url (website_base_url) of the agent’s MoxiWorks website pass true.

To include ratings and reviews associated with the agent in the response, pass true.

To include bio associated with the agent in the response, pass true.

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.

A valid MoxiWorks Office ID. Use Office Endpoint to determine what moxi_works_office_id you can use.

To include only Agent objects associated with company specific programs pass true.

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.