/groups/{id}

{
  "id": "134e0111-0f67-44f6-98f0-597000290bb3",
  "remote_id": "800293",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "name": "Engineering",
  "parent_group": "2ef51b11-2c4e-4b02-8d1d-50592d9e96ef",
  "users": [
    {},
    {}
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    },
    "organization_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/groups",
      "data": null
    }
  ]
}

Returns a Group object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

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

$	curl -G https://api.merge.dev/api/knowledgebase/v1/groups/id \
>	-H "X-Account-Token: X-Account-Token" \
>	-H "Authorization: Bearer <token>" \
>	--data-urlencode expand=users,parent_group

Authentication

Path parameters

Headers

Query parameters

Response