Users
The User object is used to represent a user within the File Storage account.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

nameString
Optional
The user's name.

email_addressString
Optional
The user's email address. This is typically used to identify a user across linked accounts.

is_meBoolean
Required
Whether the user is the one who linked this account.

remote_was_deletedBoolean
Required
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
Optional

remote_dataArray
Optional


GET
/users

https://api.merge.dev/api/filestorage/v1/users

US
EU
APAC

Returns a list of User 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.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
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.

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

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

is_meString
Optional
If provided, will only return the user object for requestor.

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_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Box
Box
Dropbox
Dropbox
Google Drive
Google Drive
OneDrive
OneDrive
SharePoint
SharePoint
GET
/users/{id}

https://api.merge.dev/api/filestorage/v1/users/{id}

US
EU
APAC

Returns a User object with the given id.


Query & Path Parameters

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Box
Box
Dropbox
Dropbox
Google Drive
Google Drive
OneDrive
OneDrive
SharePoint
SharePoint