For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
    • File Picker
          • The File object
          • GET/files
          • POST/files
          • GET/files/{id}
          • GET/files/{id}/download
          • GET/files/{id}/download/request-meta
          • GET/files/download/request-meta
          • GET/files/meta/post

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsFiles

The File object

The File Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "name": "string",
7  "file_url": "string",
8  "file_thumbnail_url": "string",
9  "size": 99999,
10  "mime_type": "string",
11  "description": "string",
12  "folder": "string",
13  "checksum": {
14    "string": {}
15  },
16  "permissions": [
17    {
18      "id": "string",
19      "remote_id": "string",
20      "created_at": "2023-01-01T00:00:00Z",
21      "modified_at": "2023-01-01T00:00:00Z",
22      "user": "string",
23      "group": "string",
24      "type": "USER",
25      "roles": [
26        "READ"
27      ],
28      "remote_was_deleted": true,
29      "field_mappings": {
30        "organization_defined_targets": {
31          "string": {}
32        },
33        "linked_account_defined_targets": {
34          "string": {}
35        }
36      }
37    }
38  ],
39  "drive": "string",
40  "remote_created_at": "2023-01-01T00:00:00Z",
41  "remote_updated_at": "2023-01-01T00:00:00Z",
42  "remote_was_deleted": true,
43  "field_mappings": {
44    "organization_defined_targets": {
45      "string": {}
46    },
47    "linked_account_defined_targets": {
48      "string": {}
49    }
50  },
51  "remote_data": [
52    {
53      "path": "string",
54      "data": {}
55    }
56  ]
57}
Was this page helpful?
Previous

/drives/{id}

Next

/files

The File object is used to represent a file in the workspace. The Object typically exists under a folder or drive, if it exists.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
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

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
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_was_deletedbooleanOptionalRead-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 nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only