Product Associations

client_office_id

Office Info: This is the ID of the office utilized by the company.
API Image API

twitter

Office Info: Office’s Twitter account name.
Roster Image Roster

google_plus

General Info: This will be null. Deprecated field related to a product that no longer exists, offered by Google many moons ago.

Roster Image Roster

facebook

Office Info: Office’s Facebook page url.
Roster Image Roster

region

General Info: The region the office is in.

Roster Image Roster

company_programs

Office Info: A list of the company specific program names in which the agent’s office participates or is a member.
API Image API

created_timestamp

Office Info: This is the Unix timestamp representing the date that this Office was created in the MoxiWorks system.
API Image API
Roster Image Roster

deactivated_timestamp

Office Info: This is the Unix timestamp representing the date that this Office was deactivated in the MoxiWorks system. This will be returned null if the office is still active.
API Image API
Roster Image Roster

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

address

Office Info: The street address of the office.
Roster Image Roster

moxi_works_office_id

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

API Image API
Roster Image Roster

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

name

General Info: This name attribute is shared between several endpoints, and generally represents the full name of the entity.

Roster Image Roster

page_number

General Info: 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.

API Image API

deactivated

Office Info: To find offices deactivated within the specified timeframe, pass true for this boolean parameter.
API Image API

deactivated_since

Office Info: Any Office objects deactivated after this Unix timestamp will be returned in the response. If no deactivated_since parameter is included in the request, only Office objects deactivated in the last seven days will be returned.
API Image API

city

Office Info: The city the office is in.
Roster Image Roster

state

Office Info: The state or provice the office is in.
Roster Image Roster

zip_code

Office Info: The postal code the office is in.
Roster Image Roster

total_pages

Office Info: The total number of pages in this response set.
API Image API

logo_url

Office Info: URL of the office logo image.
Roster Image Roster

id

Office Info: An alternate integer ID of the office. If you are integrating with MoxiWorks Authentication services, you should use this ID.
API Image API

common_name

Office Info: The commonly known name of the office. This can be null if there is no data for this attribute.
Roster Image Roster

image_url

Office Info: URL to an image of the office.
Roster Image Roster

address2

Office Info: The suite or office number of the office.
Roster Image Roster

county

Office Info: The county the office is in. This can be null if there is no data for this attribute.
Roster Image Roster

alt_phone

Office Info: Alternate phone number for the office. This should be considered second in priority to phone_number.
Roster Image Roster

email

Office Info: This is the office’s main email address. This email address should be considered the email address the office would prefer to be contacted by.
Roster Image Roster

phone

Office Info: This is the office’s main phone number. This number should be considered the number the office would prefer to be contacted by.
Roster Image Roster

timezone

Office Info: Timezone the office is in.
Roster Image Roster

office_website

Office Info: Office’s website URL.
Roster Image Roster
Websites Image Websites

mailing_address

Office Info: The street address where the office accepts mail.
Roster Image Roster

mailing_address2

Office Info: The suite or office number of the office’s mailing address.
Roster Image Roster

mailing_city

Office Info: The city the office mailing address is in.
Roster Image Roster

mailing_zip

Office Info: The postal code the office mailing address is in.
Roster Image Roster

mailing_state

Office Info: The state or provice the office mailing address is in.
Roster Image Roster

offices

Office Info: The offices array contains Dictionary objects representing Office entries. [see, documentation]
API Image API