groups

Retrieve

Returns a Group object with the given id.

get/knowledgebase/v1/groups/{id}

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/knowledgebase/v1/groups/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

expand'parent_group' | 'users' | 'users,parent_group'

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

include_remote_databoolean

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

include_shell_databoolean

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

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

idstring uuid
remote_idstring nullable

The third-party API ID of the matching object.

created_atstring date-time

The datetime that this object was created by Merge.

modified_atstring date-time

The datetime that this object was modified by Merge.

namestring nullable

The group's name.

parent_groupstring uuid nullable

The parent group for this group.

remote_was_deletedboolean

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_mappingsGroupFieldMappings

Changes

No recorded changes to this operation across all 1 revision of this API.