Users
The User
object is used to represent a user within the File Storage account.The User object
Properties
id
StringRequired
remote_id
StringOptional
The third-party API ID of the matching object.
name
StringOptional
The user's name.
email_address
StringOptional
The user's email address. This is typically used to identify a user across linked accounts.
field_mappings
ObjectOptional
modified_at
StringRequired
This is the datetime that this object was last updated by Merge
remote_data
ArrayOptional
The User object
JSON
{"id": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_id": "14","name": "Max Gong","email_address": "[email protected]",Show advanced fields}
GET
/users
Returns a list of User
objects.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
created_after
StringOptional
If provided, will only return objects created after this datetime.
created_before
StringOptional
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
StringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
StringOptional
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.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_id": "14","name": "Max Gong","email_address": "[email protected]",Show advanced fields}]}
Field support by platform

Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
Arrayremote_id
String
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_id
String
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
Arrayremote_id
String
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
Arrayremote_id
StringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/users/{id}
Returns a User
object with the given id
.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
id
StringRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"id": "56ce474c-asdf-34a2-754r-629f799f7d31","remote_id": "14","name": "Max Gong","email_address": "[email protected]",Show advanced fields}
Field support by platform

Box
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
Arrayremote_id
String
Google Drive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_id
String
OneDrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
Arrayremote_id
String
SharePoint
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_address
Stringname
Stringremote_data
Arrayremote_id
StringHint: Use the /linked-accounts endpoint to pull platform support information.