The Group object

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

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.

namestring or nullOptional<=254 characters

The group's name.

parent_groupstring or nullOptionalformat: "uuid"

The parent group for this group.

userslist of objectsOptional

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	"name": "string",
7	"parent_group": "string",
8	"users": [
9	{
10	"id": "string",
11	"remote_id": "string",
12	"created_at": "2023-01-01T00:00:00Z",
13	"modified_at": "2023-01-01T00:00:00Z",
14	"name": "string",
15	"email_address": "string",
16	"remote_was_deleted": true,
17	"field_mappings": {}
18	}
19	],
20	"remote_was_deleted": true,
21	"field_mappings": {},
22	"remote_data": [
23	{
24	"path": "string",
25	"data": {}
26	}
27	]
28	}