For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Group object
          • GET/groups
          • GET/groups/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsGroups

The Group object

The Group Object
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}
Was this page helpful?
Previous

/containers/{id}

Next

/groups

Built with

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
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
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only