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  "users": [
8    "string"
9  ],
10  "remote_created_at": "2023-01-01T00:00:00Z",
11  "remote_updated_at": "2023-01-01T00:00:00Z",
12  "remote_was_deleted": true,
13  "field_mappings": {},
14  "remote_data": [
15    {
16      "path": "string",
17      "data": {}
18    }
19  ]
20}
Was this page helpful?
Previous

/users/{id}

Next

/groups

Built with

The Group object is used to represent any subset of Users.

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 name of the Group
userslist of stringsOptional
remote_created_atdatetime or nullOptional
When the third party's group was created.
remote_updated_atdatetime or nullOptional
When the third party's group was updated.
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