Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 1.95 KB

Group.md

File metadata and controls

26 lines (22 loc) · 1.95 KB

Group

Properties

Name Type Description Notes
object String String representing the object’s type. Objects of the same type share the same schema. [optional]
id UUID ID of the group. UUID Version 4.
type String The type of the group. Can be CREATOR, AGENT, or BROKERAGE, and may dictate the attributes of the group returned.
name String The name of the group.
email String The email address of a group. [optional]
phone String A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens). [optional]
websiteUrl String The website URL of a group. [optional]
logoUrl String The logo URL of a group. [optional]
avatarUrl String The profile image URL of a real estate agent. Only returned if group's type is AGENT. [optional]
officeName String The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT. [optional]
licenseNumber String The license number of a real estate agent. Only returned if group's type is AGENT. [optional]
socialProfiles SocialProfiles [optional]
defaultOrderForm OrderForm [optional]
orderForms [OrderForm] An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR. [optional]
owner User [optional]
users [User] The Aryeo users associated with this group. [optional]
isBrokerageOrBrokerageAgent Bool Does this group represent a brokerage or an agent who belongs to a brokerage?

[Back to Model list] [Back to API list] [Back to README]