Skip to content

Latest commit

 

History

History
20 lines (12 loc) · 1.15 KB

Group.md

File metadata and controls

20 lines (12 loc) · 1.15 KB

Group

The Group Object ### Description The Group object is used to represent Group information that employees belong to. This is often referenced with an Employee object. Please note: The teams object will fulfill most use cases. The Groups object is for power-users that want all types of groups at a company and the optionality of pulling multiple groups for an employee. ### Usage Example Fetch from the LIST Employee endpoint and expand groups to view an employee's groups.

Properties

Name Type Description Notes
id UUID [optional] [readonly]
remoteId String The third-party API ID of the matching object. [optional]
parentGroup UUID The parent group for this group. [optional]
name String The group name. [optional]
type GroupTypeEnum The group type [optional]
remoteData List<RemoteData> [optional] [readonly]
remoteWasDeleted Boolean Indicates whether or not this object has been deleted on the third-party. [optional] [readonly]