agents - Windermere Real Estate API

Authorizations

x-api-key

string

header

required

Query Parameters

moxi_works_company_id

string

required

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

page_number

integer

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.

updated_since

integer

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.

deactivated

boolean

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

deactivated_since

integer

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.

include_access_level

boolean

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

include_company_programs

boolean

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

include_partners

boolean

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

include_website

boolean

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

include_reviews

boolean

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

include_bio

boolean

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

parent_company_id

string

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:

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

moxi_works_office_id

string

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

has_company_programs

boolean

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

timestamps_only

boolean

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.

Response

200 - application/json

moxi_works_agent_id

string

agent_uuid

string

client_id_1

any

client_id_2

string

client_auths

array

facebook_account_id

string

client_agent_id

any

auth_client_id

any

mls_agent_id

any

license

string

mls_name

string

mls_abbreviation

string

available_mls

object[]

Show child attributes

moxi_works_office_id

string

office_id

integer

office_name

string

client_office_id

string

company_id

integer

client_company_id

string

alternate_internal_office_id

any

office_address_street

string

office_address_street2

any

office_address_city

string

office_address_state

string

office_address_zip

string

office_mailing_address_street

string

office_mailing_address_street2

any

office_mailing_address_city

string

office_mailing_address_state

string

office_mailing_address_zip

string

name

any

first_name

any

last_name

any

nickname

any

mobile_phone_number

any

alt_phone_number

any

fax_phone_number

any

main_phone_number

string

office_phone_number

string

primary_email_address

string

secondary_email_address

string

lead_routing_email_address

any

email_addresses

object

Show child attributes

bio

any

title

string

designations

any

uuid

string

has_product_access

boolean

has_engage_access

boolean

access_level

string

view_level

string

teams

array

website_base_url

any

twitter

any

google_plus

any

facebook

any

instagram

any

blogger

any

youtube

any

linked_in

any

home_page

string

profile_image_url

string

profile_thumb_url

string

region

string

service_area_zip_codes

array

agent_website

object

Show child attributes

alternate_offices

array

partners

array

company_programs

array

source_metadata

object[]

Show child attributes

created_timestamp

integer

deactivated_timestamp

any

last_updated_timestamp

integer

last_updated

integer

modification_timestamp

string

profile_visible_online

boolean

languages

array

user_reviews

array

Endpoints

Documentation Index

Authorizations

Query Parameters

Response