Common ModelsGroups

/groups/{id}

Returns a Group object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

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

userslist of strings

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.

idstring or nullRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only
The datetime that this object was created by Merge.
modified_atdatetime or nullRead-only
The datetime that this object was modified by Merge.
namestring or null<=254 characters
The group's name.
child_groupslist of strings or nullRead-only
Groups that inherit the permissions of the parent group.
remote_was_deletedboolean or nullRead-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](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA82VYW/aMBCG/8p0H1FIRimrGmmagDBKNUzXptW6qopMciQGxw62A5Sq/31KoC1s1dpVVN23+HT3nu+5V84thNRgLNUNuDBiHLWRisYIFqQyQg4udJXMM7CAZozQFLfzgtkeWKDzLJPKYPSVIY/0kcIRuOCkqGKs5oKNGEbORpXDhMFYUcOk0M5DdXVUloMFnIkJRs0wlLkwL9Bb5VfpquC3o3Y40wYsyKjWJlEyj5NTnOaoXyJd3I5jisJQXo2ooc6GTFWtdJ6KFXNEyNFg5FFDPTQYFgOvWybGZNp1nAR5Zpft7QhnDgqHKsNCjtpp1A/3Dg4b1bVK2f1LEPPPtcp4OpTDg0oQhzygeaXvhwvi9+ZkHO+T9v6CLM8bZDlZkvHkYyWIaaXv9xsD/7I+8Jq1wRMJwdmnH4cXLa91TCrhslMn48s58cNa3w8nw2WvftwN58dH3xdkebnX987rxO80jruyNmif6n77VPabtg0WbO4V3KvbzcDaPC252E7spYXfHoGsVkEzVs3yIWehres2TelSCjrXdihTJ8WIUeeEUzOSKm3JRaCnOVUYjIma/zwQdibie/hMigfy4EKHHDVJu+Ntu6E5o4zTIUdwjcrxD0ODe7Vp+gxVyrQuh7RAFHNZsB1UmEqDQbGx7VOQUZM8hlgEFuQalYbrIjjNmcLohCqaoimi7tX1nfUUR0/JbLhrlmvRe57pN3GRiJs34flO2LpSxhw/eIrNcDfsVopBqRicleD+Aow0/d5F599xhQnjURAXb3EBasON8fp9/t8MOhC4Q8r3Dh0IjErS+jnSr7fm86x3gFSwaV58ozDFT0e9FvNZQhWeSCbMbkGXulmh+zzqtzP1+4C+vvsFHyWoMBgJAAA=" />