office - Windermere Real Estate API

Authorizations

x-api-key

string

header

required

Path Parameters

moxi_works_office_id

string

required

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

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.

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

required

A valid MoxiWorks Office ID. Use Office Index Endpoint for a list of all Office objects associated with a Company or use the moxi_works_office_id attribute returned in an Agent response.

Response

200 - application/json

moxi_works_office_id

string

client_office_id

string

image_url

string

name

string

common_name

string

address

string

address2

any

city

string

county

string

state

string

zip_code

string

alt_phone

string

facebook

any

google_plus

any

phone

string

timezone

string

twitter

any

office_website

string

region

string

mailing_address

string

mailing_address2

string

mailing_city

string

mailing_zip

string

mailing_state

string

company_programs

string[]

logo_url

string