The Group object

The Group object is used to represent any subset of employees across, for example, DEPARTMENT or TEAM. Employees can be in multiple Groups.

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

parent_groupstring or nullOptionalformat: "uuid"

The parent group for this group.

namestring or nullOptional

The group name.

typeenum or nullOptional

The Group type returned directly from the third-party.

TEAM - TEAM
DEPARTMENT - DEPARTMENT
COST_CENTER - COST_CENTER
BUSINESS_UNIT - BUSINESS_UNIT
GROUP - GROUP

Allowed values:

is_commonly_used_as_teamboolean or nullOptional

Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct.

remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

1	{
2	"id": "string",
3	"remote_id": "string",
4	"created_at": "2023-01-01T00:00:00Z",
5	"modified_at": "2023-01-01T00:00:00Z",
6	"parent_group": "string",
7	"name": "string",
8	"type": "TEAM",
9	"is_commonly_used_as_team": true,
10	"remote_was_deleted": true,
11	"field_mappings": {},
12	"remote_data": [
13	{
14	"path": "string",
15	"data": {}
16	}
17	]
18	}