/files

Returns a list of File objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

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

created_beforedatetimeOptional

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

cursorstringOptional

The pagination cursor value.

drive_idstringOptional

Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.

expandenumOptional

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

folder_idstringOptional

Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.

include_deleted_databooleanOptional

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.

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).

mime_typestringOptional

If provided, will only return files with these mime_types. Multiple values can be separated by commas.

modified_afterdatetimeOptional

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

modified_beforedatetimeOptional

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

namestringOptional

If provided, will only return files with this name. This performs an exact match.

order_byenumOptional

Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.

Allowed values:

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_created_afterdatetimeOptional

If provided, will only return files created in the third party platform after this datetime.

remote_created_beforedatetimeOptional

If provided, will only return files created in the third party platform before this datetime.

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects or null

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

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 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	response = client.file_storage.files.list(
8	cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
9	)
10	for item in response:
11	yield item
12	# alternatively, you can paginate page-by-page
13	for page in response.iter_pages():
14	yield page

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

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration