The Group object

The Group object is used to represent any subset of Users. This can extend to company domains as well.

userslist of stringsRequired

The users that belong in the group. If null, this typically means it's either a domain or the third-party platform does not surface this information.

idstringOptionalformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptional

The datetime that this object was created by Merge.

modified_atdatetimeOptional

The datetime that this object was modified by Merge.

namestring or nullOptional<=254 characters

The group's name.

child_groupslist of stringsOptional

Groups that inherit the permissions of the parent group.

remote_was_deletedbooleanOptional

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 nullOptional

remote_datalist of objects or nullOptional

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	"name": "string",
7	"users": [
8	"string"
9	],
10	"child_groups": [
11	"string"
12	],
13	"remote_was_deleted": true,
14	"field_mappings": {},
15	"remote_data": [
16	{
17	"path": "string",
18	"data": {}
19	}
20	]
21	}