The Group object

{
  "id": "string",
  "remote_id": "string",
  "created_at": "2023-01-01T00:00:00Z",
  "modified_at": "2023-01-01T00:00:00Z",
  "name": "string",
  "parent_group": "string",
  "users": [
    {
      "id": "string",
      "remote_id": "string",
      "created_at": "2023-01-01T00:00:00Z",
      "modified_at": "2023-01-01T00:00:00Z",
      "name": "string",
      "email_address": "string",
      "is_active": true,
      "teams": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "avatar": "string",
      "remote_was_deleted": true,
      "field_mappings": {},
      "remote_data": [
        {
          "path": "string",
          "data": {}
        }
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {},
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ]
}

The Group object is used to represent any subset of employees across, for example, DEPARTMENT or TEAM. Employees can be in multiple Groups.

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.

parent_groupstring or nullOptionalformat: "uuid"

The parent group for this group.

userslist of objectsOptional

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