/folders/{id}

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.filestorage.folders.retrieve("id", {
    includeRemoteData: true,
    includeShellData: true
});

{
  "id": "e021f7a7-74fc-4487-8e12-14180c92d3b7",
  "remote_id": "14",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "name": "R&D",
  "folder_url": "https://drive.com/1234",
  "size": 2738000,
  "description": "All things R&D related at Merge!",
  "parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31",
  "drive": "31ce474c-asdf-34a2-754r-629f799f7d12",
  "permissions": [
    {
      "id": "105b9265-0d52-4e5c-bb88-0cb681ec77f6",
      "remote_id": "102895",
      "created_at": "2020-03-31T00:00:00Z",
      "modified_at": "2020-06-20T00:00:00Z",
      "user": "21ce474c-asdf-34a2-754r-629f799f7d12",
      "type": "USER",
      "roles": [
        "OWNER"
      ]
    },
    {
      "id": "a77ac1b4-a04f-4baa-a388-de3c0c173e1c",
      "created_at": "2020-03-31T00:00:00Z",
      "modified_at": "2020-06-20T00:00:00Z",
      "group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "GROUP",
      "roles": [
        "READ"
      ]
    }
  ],
  "remote_created_at": "2024-02-02T00:00:00Z",
  "remote_updated_at": "2024-06-10T00:00:00Z",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/folders"
    }
  ]
}

Returns a Folder object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_remote_databooleanOptional

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

include_shell_databooleanOptional

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

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

namestring or null<=254 characters

The folder's name.

folder_urlstring or null<=2000 characters

The URL to access the folder.

sizelong or null-9223372036854776000-9223372036854776000

The folder's size, in bytes.

descriptionstring or null<=2000 characters

The folder's description.

parent_folderstring or nullformat: "uuid"

The folder that the folder belongs to.

drivestring or nullformat: "uuid"

The drive that the folder belongs to.

permissionslist of objects

remote_created_atdatetime or null

When the third party's folder was created.

remote_updated_atdatetime or null

When the third party's folder was updated.

remote_was_deletedbooleanRead-only

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 or nullRead-only

remote_datalist of objects or nullRead-only

Authentication

Path parameters

Headers

Query parameters

Response