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}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsGroups

/groups/{id}

GET
/filestorage/v1/groups/:id
GET
/api/filestorage/v1/groups/:id
$curl -G https://api.merge.dev/api/filestorage/v1/groups/id \
>     -H "X-Account-Token: X-Account-Token" \
>     -H "Authorization: Bearer <token>" \
>     --data-urlencode expand=users,child_groups
200Retrieved
1{
2  "users": [
3    "6e93361b-8ae7-444b-bfa2-71206cbbee24"
4  ],
5  "id": "5624aceb-0ea2-4864-ba08-354ac56b9884",
6  "remote_id": "19202938",
7  "created_at": "2021-09-15T00:00:00Z",
8  "modified_at": "2021-10-16T00:00:00Z",
9  "name": "Administrators",
10  "child_groups": [
11    "a1f90b3c-633d-404e-a696-05cd54808676"
12  ],
13  "remote_was_deleted": true,
14  "field_mappings": {
15    "organization_defined_targets": {
16      "custom_key": "custom_value"
17    },
18    "linked_account_defined_targets": {
19      "custom_key": "custom_value"
20    }
21  },
22  "remote_data": [
23    {
24      "path": "/groups",
25      "data": null
26    }
27  ]
28}

Returns a Group object with the given id.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Was this page helpful?
Previous

/groups

Next

The User object

Built with

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.

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
namestring or null<=254 characters
The group's name.
child_groupslist of stringsRead-only
Groups that inherit the permissions of the parent group.
remote_was_deletedbooleanRead-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 nullRead-only
remote_datalist of objects or nullRead-only