Merge File Storage

Groups

The Group object is used to represent any subset of Users. This can extend to company domains as well.

The Group object

Properties

usersArray

Required

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.

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

nameString

Optional

The group's name.

field_mappingsObject

Optional

modified_atString

Required

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

remote_dataArray

Optional

The Group object

JSON


{
  "id": "21ce474c-asdf-34a2-754r-629f799f7d12",
  "remote_id": "340",
  "name": "Platform",
  "users": [
    "56ce474c-asdf-34a2-754r-629f799f7d31"
  ],
Show advanced fields
}

GET

/groups

Returns a list of Group 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": "21ce474c-asdf-34a2-754r-629f799f7d12",
      "remote_id": "340",
      "name": "Platform",
      "users": [
        "56ce474c-asdf-34a2-754r-629f799f7d31"
      ],
Show advanced fields
    }
  ]
}

Box

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataArray

remote_idString

Google Drive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_idString

OneDrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataArray

remote_idString

SharePoint

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

nameString

remote_dataArray

remote_idString

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

GET

/groups/{id}

Returns a Group 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": "21ce474c-asdf-34a2-754r-629f799f7d12",
  "remote_id": "340",
  "name": "Platform",
  "users": [
    "56ce474c-asdf-34a2-754r-629f799f7d31"
  ],
Show advanced fields
}