Group.md

Group

Properties

Name	Type	Description	Notes
object	Option<String>	String representing the object’s type. Objects of the same type share the same schema.	[optional]
id	String	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	Option<String>	The email address of a group.	[optional]
phone	Option<String>	A phone number represented in whichever standards specified by the group, typically ###-###-#### (separated by hyphens).	[optional]
website_url	Option<String>	The website URL of a group.	[optional]
logo_url	Option<String>	The logo URL of a group.	[optional]
avatar_url	Option<String>	The profile image URL of a real estate agent. Only returned if group's type is AGENT.	[optional]
office_name	Option<String>	The name of the brokerage or team of a real estate agent. Only returned if group's type is AGENT.	[optional]
license_number	Option<String>	The license number of a real estate agent. Only returned if group's type is AGENT.	[optional]
social_profiles	Option<crate::models::SocialProfiles>		[optional]
default_order_form	Option<crate::models::OrderForm>		[optional]
order_forms	Option<Veccrate::models::OrderForm>	An array of order forms a vendor group provides for placing orders. Only returned if group's type is CREATOR.	[optional]
owner	Option<crate::models::User>		[optional]
users	Option<Veccrate::models::User>	The Aryeo users associated with this group.	[optional]
is_brokerage_or_brokerage_agent	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]