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
    • File Picker
          • The Group object
          • GET/groups
          • GET/groups/{id}

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
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  "child_groups": [
11    "string"
12  ],
13  "remote_was_deleted": true,
14  "field_mappings": {
15    "organization_defined_targets": {
16      "string": {}
17    },
18    "linked_account_defined_targets": {
19      "string": {}
20    }
21  },
22  "remote_data": [
23    {
24      "path": "string",
25      "data": {}
26    }
27  ]
28}
Was this page helpful?
Previous

/folders/meta/post

Next

/groups

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.

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.
child_groupslist of stringsOptionalRead-only
Groups that inherit the permissions of the parent group.
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