/folders/{id}

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

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-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 or null

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

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

descriptionstring or nullOptional<=2000 characters

The folder's description.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

permissionslist of objectsOptional

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

descriptionstring or nullOptional<=2000 characters

The folder's description.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

drivestring or nullOptionalformat: "uuid"

The drive that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

drivestring or nullOptionalformat: "uuid"

The drive that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

drivestring or nullOptionalformat: "uuid"

The drive that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

descriptionstring or nullOptional<=2000 characters

The folder's description.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

permissionslist of objectsOptional

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

descriptionstring or nullOptional<=2000 characters

The folder's description.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

drivestring or nullOptionalformat: "uuid"

The drive that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

drivestring or nullOptionalformat: "uuid"

The drive that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional<=254 characters

The folder's name.

folder_urlstring or nullOptional<=2000 characters

The URL to access the folder.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The folder's size, in bytes.

parent_folderstring or nullOptionalformat: "uuid"

The folder that the folder belongs to.

drivestring or nullOptionalformat: "uuid"

The drive that the folder belongs to.

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's folder was created.

remote_updated_atdatetime or nullOptional

When the third party's folder was updated.

remote_datalist of objects or nullOptionalRead-only

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

1	{
2	"id": "e021f7a7-74fc-4487-8e12-14180c92d3b7",
3	"remote_id": "14",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"name": "R&D",
7	"folder_url": "https://drive.com/1234",
8	"size": 2738000,
9	"description": "All things R&D related at Merge!",
10	"parent_folder": "47ce474c-asdf-34a2-754r-629f799f7d31",
11	"drive": "31ce474c-asdf-34a2-754r-629f799f7d12",
12	"permissions": [
13	{
14	"id": "105b9265-0d52-4e5c-bb88-0cb681ec77f6",
15	"remote_id": "102895",
16	"created_at": "2020-03-31T00:00:00Z",
17	"modified_at": "2020-06-20T00:00:00Z",
18	"user": "21ce474c-asdf-34a2-754r-629f799f7d12",
19	"type": "USER",
20	"roles": [
21	"OWNER"
22	]
23	},
24	{
25	"id": "a77ac1b4-a04f-4baa-a388-de3c0c173e1c",
26	"created_at": "2020-03-31T00:00:00Z",
27	"modified_at": "2020-06-20T00:00:00Z",
28	"group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
29	"type": "GROUP",
30	"roles": [
31	"READ"
32	]
33	}
34	],
35	"remote_created_at": "2024-02-02T00:00:00Z",
36	"remote_updated_at": "2024-06-10T00:00:00Z",
37	"remote_was_deleted": true,
38	"field_mappings": {
39	"organization_defined_targets": {
40	"custom_key": "custom_value"
41	},
42	"linked_account_defined_targets": {
43	"custom_key": "custom_value"
44	}
45	},
46	"remote_data": [
47	{
48	"path": "/folders"
49	}
50	]
51	}

/folders/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration