/files/{id}

Returns a File 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 file's name.

file_urlstring or null<=2000 characters

The URL to access the file.

file_thumbnail_urlstring or null<=2000 characters

The URL that produces a thumbnail preview of the file. Typically an image.

sizelong or null-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or null<=128 characters

The file's mime type.

descriptionstring or null<=2000 characters

The file's description.

folderstring or nullformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or null

This field stores file checksum data. ‘type’ indicates the algorithm (e.g. crc_32, sha1, sha256, quickXor, or md5), and ‘content_hash’ is the unique hash used to verify file integrity and detect alterations.

permissionslist of objects or null

drivestring or nullformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or null

When the third party's file was created.

remote_updated_atdatetime or null

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

descriptionstring or nullOptional<=2000 characters

The file's description.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

file_thumbnail_urlstring or nullOptional<=2000 characters

The URL that produces a thumbnail preview of the file. Typically an image.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

descriptionstring or nullOptional<=2000 characters

The file's description.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

descriptionstring or nullOptional<=2000 characters

The file's description.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

file_thumbnail_urlstring or nullOptional<=2000 characters

The URL that produces a thumbnail preview of the file. Typically an image.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

descriptionstring or nullOptional<=2000 characters

The file's description.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file 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 file's name.

file_urlstring or nullOptional<=2000 characters

The URL to access the file.

sizelong or nullOptional-9223372036854776000-9223372036854776000

The file's size, in bytes.

mime_typestring or nullOptional<=128 characters

The file's mime type.

folderstring or nullOptionalformat: "uuid"

The folder that the file belongs to.

checksummap from strings to any or nullOptional

permissionslist of objectsOptional

drivestring or nullOptionalformat: "uuid"

The drive that the file belongs to.

remote_created_atdatetime or nullOptional

When the third party's file was created.

remote_updated_atdatetime or nullOptional

When the third party's file was updated.

remote_datalist of objects or nullOptionalRead-only

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	client.file_storage.files.retrieve(
8	id="id",
9	)

1	{
2	"id": "45ce474c-dhcj-43a6-754r-629f799f7d68",
3	"remote_id": "12",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"name": "merge_file_storage_launch.docx",
7	"file_url": "https://drive.com/1234",
8	"file_thumbnail_url": "https://drive.com/1234/thumbnail.png",
9	"size": 254,
10	"mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
11	"description": "Use common model scopes to redact data returned in Merge's Common Models!",
12	"folder": "8e889422-e086-42dc-b99e-24d732039b0b",
13	"checksum": {
14	"type": "sha256",
15	"content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
16	},
17	"permissions": [
18	{
19	"id": "31ce489c-asdf-68b1-754r-629f799f7123",
20	"remote_id": "102895",
21	"created_at": "2020-03-31T00:00:00Z",
22	"modified_at": "2020-06-20T00:00:00Z",
23	"user": "21ce474c-asdf-34a2-754r-629f799f7d12",
24	"type": "USER",
25	"roles": [
26	"OWNER"
27	]
28	},
29	{
30	"id": "2ea7db93-1ae9-4686-82c9-35c768000736",
31	"created_at": "2020-03-31T00:00:00Z",
32	"modified_at": "2020-06-20T00:00:00Z",
33	"group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
34	"type": "GROUP",
35	"roles": [
36	"READ"
37	]
38	}
39	],
40	"drive": "204ca79c-0c86-4f6c-9ca6-61b946a4708a",
41	"remote_created_at": "2022-02-02T00:00:00Z",
42	"remote_updated_at": "2022-02-03T00:00:00Z",
43	"remote_was_deleted": true,
44	"field_mappings": {
45	"organization_defined_targets": {
46	"custom_key": "custom_value"
47	},
48	"linked_account_defined_targets": {
49	"custom_key": "custom_value"
50	}
51	},
52	"remote_data": [
53	{
54	"path": "/files"
55	}
56	]
57	}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration