Groups
The
Group
object is used to represent any subset of Users
. This can extend to company domains as well.Properties
users
ArrayRequired
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.
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
name
StringOptional
The group's name.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
field_mappings
ObjectOptional
remote_data
ArrayOptional
GET
/groups
https://api.merge.dev/api/filestorage/v1/groups
US
EU
APAC
Returns a list of Group
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
![Box](https://merge-api-production.s3.amazonaws.com/media/PlatformBox_square.png)
Box
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
Array![Dropbox](https://merge-api-production.s3.amazonaws.com/media/PlatformDropbox_square_mLnVhny.png)
Dropbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_id
String![Google Drive](https://merge-api-production.s3.amazonaws.com/media/PlatformGoogle_Drive_square.png)
Google Drive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
Array![OneDrive](https://merge-api-production.s3.amazonaws.com/media/PlatformOnedrive_square.png)
OneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
Array![SharePoint](https://merge-api-production.s3.amazonaws.com/media/PlatformSharepoint_square.png)
SharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
ArrayGET
/groups/{id}
https://api.merge.dev/api/filestorage/v1/groups/{id}
US
EU
APAC
Returns a Group
object with the given id
.
Query & Path Parameters
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
![Box](https://merge-api-production.s3.amazonaws.com/media/PlatformBox_square.png)
Box
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
Array![Dropbox](https://merge-api-production.s3.amazonaws.com/media/PlatformDropbox_square_mLnVhny.png)
Dropbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_id
String![Google Drive](https://merge-api-production.s3.amazonaws.com/media/PlatformGoogle_Drive_square.png)
Google Drive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
Array![OneDrive](https://merge-api-production.s3.amazonaws.com/media/PlatformOnedrive_square.png)
OneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
Array![SharePoint](https://merge-api-production.s3.amazonaws.com/media/PlatformSharepoint_square.png)
SharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
Arrayremote_id
Stringusers
Array