Merge File Storage

Users

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

The User object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

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.

field_mappingsObject

Optional

modified_atString

Required

This is the datetime that this object was last updated by Merge

remote_dataArray

Optional

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

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

created_afterString

Optional

If provided, will only return objects created after this datetime.

created_beforeString

Optional

If provided, will only return objects created before this datetime.

cursorString

Optional

The pagination cursor value.

include_deleted_dataBoolean

Optional

Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean

Optional

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

modified_afterString

Optional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString

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.

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
    }
  ]
}

Box

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

remote_dataArray

remote_idString

Google Drive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

remote_idString

OneDrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

remote_dataArray

remote_idString

SharePoint

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

email_addressString

nameString

remote_dataArray

remote_idString

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

GET

/users/{id}

Returns a User object with the given id.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Query & Path Parameters

idString

Required

include_remote_dataBoolean

Optional

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
}