Groups
The
Group object is used to represent any subset of Users. This can extend to company domains as well.Properties
usersArrayRequired
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.
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
nameStringOptional
The group's name.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
created_atDateTime (ISO 8601)Required
modified_atDateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
remote_dataArrayOptional
GET
/groups
https://api.merge.dev/api/filestorage/v1/groups
US
EU
Returns a list of Group objects.
Query & Path Parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fields
Box
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_dataArrayremote_idStringusersArray
Dropbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_idString
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
nameStringremote_idString
OneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_dataArrayremote_idStringusersArray
SharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_dataArrayremote_idStringusersArrayGET
/groups/{id}
https://api.merge.dev/api/filestorage/v1/groups/{id}
US
EU
Returns a Group object with the given id.
Query & Path Parameters
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsBox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_dataArrayremote_idStringusersArrayDropbox
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_idStringGoogle Drive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_idStringOneDrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_dataArrayremote_idStringusersArraySharePoint
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
nameStringremote_dataArrayremote_idStringusersArray