Merge
Merge File Storage API

Merge File Storage API provides unified access to file storage platforms including Box, Dropbox, Google Drive, OneDrive, and SharePoint. It normalizes access to Drives, Files, Folders, Groups, and Users with a built-in File Picker component for browsing connected storage accounts.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: File Storage
  version: 1.0.0
paths:
  /filestorage/v1/drives:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `Drive` objects.{/* BEGIN_FILESTORAGE_DRIVE_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA8WTXW/aMBSG/8rkS5SPUcqqRpomSlgLEqYrabWqqqJDfAgGxw62A22q/vcppB/QVWsvkHYVn1fnvLYfv3kgCVhMlb4nAZlygcYqDSkSh2SKoSABCTVfVTXknEKGu33x6oA4xBR5rrRF9pOjYOZM45QExM9Qp+gWkk85Mn9ryufSYqrBciWN/zLtTjfjxCGCywWyTpKoQtpP+NX9LtQDb0rjC24scUgOxtiZVkU6u8BlgeYz1tXpBGYoLQiXgQV/y8bVtc97WnUPhgItshAshGgxqS78tOXM2twEvj9DkXub7T2GKx+lD9ryRKDx263jg6Pjtvvkstn9R5yK783GfDlRk6NGnCYihqIxjJI7GvXXdJ4e0u7hHS0v27RclHS++NqIU2gMo2F7FF23RmGnOXqnIR5/+318dRKeDGgjKXstOr9e0yhpDqNkMSn7rcFpsh6c/bqj5fXBMLxs0ajXHpyq5qh7YYbdCzXseB5xyPa7kuDmYVt4Cs+pUqnAL8+p2mroZ1XwXsnUbwI5d/NiInjimZYHGZRKwtp4icr8DBkHv3aMN47xeFmARi+X6TN+ruQLexIQ2on6V73dNHRWwAVMBJLA6gL/CjQJbgjb2BdaEKf+AZ6/dU6q5RtFCYa60jaLql9WCByiMVMW40QjWGQx2FeteuLdKs7Bzl4lzshtVSwLrpGdg4YMbeUe3Nw+Ou8BH0ncI+xzAXaqdDaSWBMxHwHv0bMO7fbCPSH/vzDHM9B4rri0+8U5rnzzyvdjoHtN8J5xOsRwi/GuUOI/MN8+/gHQUDLFhAYAAA=="
        /></Footer>{/* END_FILESTORAGE_DRIVE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_drives
      parameters:
        - name: created_after
          in: query
          description: If provided, will only return objects created after this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          description: If provided, will only return objects created before this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          description: The pagination cursor value.
          required: false
          schema:
            type: string
        - name: include_deleted_data
          in: query
          description: >-
            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](https://docs.merge.dev/integrations/hris/supported-features/).
          required: false
          schema:
            type: boolean
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: modified_after
          in: query
          description: If provided, only objects synced by Merge after this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: modified_before
          in: query
          description: If provided, only objects synced by Merge before this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: name
          in: query
          description: If provided, will only return drives with this name. This performs an exact match.
          required: false
          schema:
            type: string
        - name: page_size
          in: query
          description: Number of results to return per page. The maximum limit is 100.
          required: false
          schema:
            type: integer
        - name: remote_id
          in: query
          description: The API provider's ID for the given object.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDriveList'
  /filestorage/v1/drives/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: >-
        Returns a `Drive` object with the given `id`.{/* BEGIN_FILESTORAGE_DRIVE_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA8WTXW/aMBSG/8rkS5SPUcqqRpomSlgLEqYrabWqqqJDfAgGxw62A22q/vcppB/QVWsvkHYVn1fnvLYfv3kgCVhMlb4nAZlygcYqDSkSh2SKoSABCTVfVTXknEKGu33x6oA4xBR5rrRF9pOjYOZM45QExM9Qp+gWkk85Mn9ryufSYqrBciWN/zLtTjfjxCGCywWyTpKoQtpP+NX9LtQDb0rjC24scUgOxtiZVkU6u8BlgeYz1tXpBGYoLQiXgQV/y8bVtc97WnUPhgItshAshGgxqS78tOXM2twEvj9DkXub7T2GKx+lD9ryRKDx263jg6Pjtvvkstn9R5yK783GfDlRk6NGnCYihqIxjJI7GvXXdJ4e0u7hHS0v27RclHS++NqIU2gMo2F7FF23RmGnOXqnIR5/+318dRKeDGgjKXstOr9e0yhpDqNkMSn7rcFpsh6c/bqj5fXBMLxs0ajXHpyq5qh7YYbdCzXseB5xyPa7kuDmYVt4Cs+pUqnAL8+p2mroZ1XwXsnUbwI5d/NiInjimZYHGZRKwtp4icr8DBkHv3aMN47xeFmARi+X6TN+ruQLexIQ2on6V73dNHRWwAVMBJLA6gL/CjQJbgjb2BdaEKf+AZ6/dU6q5RtFCYa60jaLql9WCByiMVMW40QjWGQx2FeteuLdKs7Bzl4lzshtVSwLrpGdg4YMbeUe3Nw+Ou8BH0ncI+xzAXaqdDaSWBMxHwHv0bMO7fbCPSH/vzDHM9B4rri0+8U5rnzzyvdjoHtN8J5xOsRwi/GuUOI/MN8+/gHQUDLFhAYAAA=="
        /></Footer>{/* END_FILESTORAGE_DRIVE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_drives
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Drive'
  /filestorage/v1/files:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `File` objects.{/* BEGIN_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+2T207bQBCGX6Xay8ixG0KKsFRVCeGQqHEoGFSKkLVZT+xN9sTuOgcj3r2yY0jSckGlQC/aO+/szL+e+eZ/QARbSKReIh+NKQNjpcYJIAdxGQNDPjqhrDhiRQPMYTstmu0hB5lMKaktxCcUWGzONIyRjzwOOoF6JuiYQuxtVHlUWEg0tlQK4z1X18dlOXIQo2IKcZsQmQn7Cr1Vfh2vCn45Go9RY5GDFDbGplpmSXoB9xmY10gXf8eAg7CY1WNssbchU9crnZdiRR8xMLAQd7HFXbBAioarJ1NrlfE9LwWm3PJ5N4aZB8LD2lLCwHit5uHewWGrXqmUr3+JEva5UZvcj+TooBYlhEU4qw1CsgjC3jyYJPvB0f4iyK9aQT7Ng8n0Yy1KcG0QDlrD8KY57LYbwxcSostP3w+vO91OP6iR/LgZTG7mQUgag5BMR3mv2T8l8/7Zt0WQ3+wNulfNIDxu9U9lY3h0YQZHF3LQdl3koE2uyL992AxUy9ORi+3EHi/WbT2QFQqsaF1lI0aJa5ou5jiXAs+NSyT3OMQUe+cM27HUvCMXkbnPsIZoEuj5jwPhKpE8DZ9K8Tx55KOgHfauj7d3oT3DlOERA+RbncFv64z8W0RSIFOT8VLWEE1VKeiUXogyzarPamsUaE6NKcfgoLFkMejCUZRDZJeqsJMoxuGg7UylKcd6GZWq21cauLQQEQ3YQhxhu44Ve7F9ihS26TpE4/V3puK1gKE5oLvi7j6jGuJzrDEHC7po+u7ReQlgV0s12jXESvQJJP8qrlOxfFuQm+h2SOh9aZxKmTD40NV0BrtBslKMSsXosuTxnoaKq07KAds04yOBKduw2L/ltqGAHbJ9sttQQDnnym9vzHeT6O799vcZXaZYw7mkwu6WUqmrCt3/nOyfcbp7/AkqCFoM2QoAAA=="
        /></Footer>{/* END_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_files
      parameters:
        - name: created_after
          in: query
          description: If provided, will only return objects created after this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          description: If provided, will only return objects created before this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          description: The pagination cursor value.
          required: false
          schema:
            type: string
        - name: drive_id
          in: query
          description: >-
            Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside
            the top-level drive.
          required: false
          schema:
            type: string
        - name: expand
          in: query
          description: >-
            Which relations should be returned in expanded form. Multiple relation names should be comma separated
            without spaces.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/FilesGetParametersExpandSchemaItems'
        - name: folder_id
          in: query
          description: >-
            Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root
            directory.
          required: false
          schema:
            type: string
        - name: include_deleted_data
          in: query
          description: >-
            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](https://docs.merge.dev/integrations/hris/supported-features/).
          required: false
          schema:
            type: boolean
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: mime_type
          in: query
          description: If provided, will only return files with these mime_types. Multiple values can be separated by commas.
          required: false
          schema:
            type: string
        - name: modified_after
          in: query
          description: If provided, only objects synced by Merge after this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: modified_before
          in: query
          description: If provided, only objects synced by Merge before this date time will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: name
          in: query
          description: If provided, will only return files with this name. This performs an exact match.
          required: false
          schema:
            type: string
        - name: order_by
          in: query
          description: >-
            Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at,
            modified_at, -modified_at.
          required: false
          schema:
            $ref: '#/components/schemas/FilesGetParametersOrderBy'
        - name: page_size
          in: query
          description: Number of results to return per page. The maximum limit is 100.
          required: false
          schema:
            type: integer
        - name: remote_created_after
          in: query
          description: If provided, will only return files created in the third party platform after this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: remote_created_before
          in: query
          description: If provided, will only return files created in the third party platform before this datetime.
          required: false
          schema:
            type: string
            format: date-time
        - name: remote_id
          in: query
          description: The API provider's ID for the given object.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFileList'
    post:
      operationId: create
      summary: Create
      description: >-
        Creates a `File` object with the given values.{/* BEGIN_FILESTORAGE_FILE_CREATE_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="POST"
        data="H4sIAAAAAAAAA91U227aQBD9lWofkbFLCI1iqaog5AIqJk2cqGkUWct6sBf2YnbXXBzl3ysbJ0BD2jxApfZtLzNnZs45u4+IYAORVAvkoiFloI1UOAJkIS5DYMhFZ5TlW5xQD3PYDAumB8hCOk0SqQyEZxRYqC8UDJGLHA4qgmoq6JBC6KxlOVQYiBQ2VArtvGRXh0U6shCjYgxhkxCZCvMOvGV8FS8Tftlqh1FtkIUSrLWJlUyj+AomKej3QOfdMeAgDGbVEBvsrMFU1RJn21k+RwgMDIRtbHAbDJB84LJkbEyiXceJgSV2Ud4OYeqAcLAylDDQTqN+fHB03KiWKEX1L0HEPtcqo8lADo4qQURYgNNKzydzz+/MvFF06J0czr3spuFl48wbjT9WgghXen6v0ffv6v12s9bfEhBcf/p+fNtqt7pehWSndW90N/N8Uuv5ZDzIOvXuOZl1L77NvezuoNe+qXv+aaN7Lmv9kyvdO7mSvaZtIwut64rc+8f1g9I8LTnfDOzw3G4rQpZS4IRWk3TAKLF13cYcZ1LgmbaJ5A6HkGLnkmEzlIq35DzQkxQrCEaemv04EnYiomfyqRQvzCMXeU2/c3u66YXmFFOGBwyQa1QKr+yM3HsUgiaKJgWKVTyAIFWsXJZWSUBxqnUxu4WGkoWg8mdEOQRmkeRvSOQcWGgzUgGXBgKiABsIA2xWZzRcrdMkXN1rmgF6yO8mKVUQXmKFORhQRbdr/RUVH56sbVK0lUwGu5ajBH2WhH8Vt7FY7EGSdRF+w/VfYfJcyojBh7aiU9gNnUvEoEAMrgsu98AhiYGMdcpz2LL3YmITp3wgMGVrLv9HDP+q+huS9QXsUK5n9/cFFESW9t/HT7Su0/8lyXWMFVxKKsxuRSlwkxx3f7KQN17Snz+oTSESRTlWi6BI3rdGWzrdotXD009G2X+MJQoAAA=="
        /></Footer>{/* END_FILESTORAGE_FILE_CREATE_SUPPORTED_FIELDS */}
      tags:
        - subpackage_files
      parameters:
        - name: is_debug_mode
          in: query
          description: Whether to include debug fields (such as log file links) in the response.
          required: false
          schema:
            type: boolean
        - name: run_async
          in: query
          description: Whether or not third-party updates should be run asynchronously.
          required: false
          schema:
            type: boolean
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileStorageFileResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileStorageFileEndpointRequest'
  /filestorage/v1/files/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: >-
        Returns a `File` object with the given `id`.{/* BEGIN_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+2T207bQBCGX6Xay8ixG0KKsFRVCeGQqHEoGFSKkLVZT+xN9sTuOgcj3r2yY0jSckGlQC/aO+/szL+e+eZ/QARbSKReIh+NKQNjpcYJIAdxGQNDPjqhrDhiRQPMYTstmu0hB5lMKaktxCcUWGzONIyRjzwOOoF6JuiYQuxtVHlUWEg0tlQK4z1X18dlOXIQo2IKcZsQmQn7Cr1Vfh2vCn45Go9RY5GDFDbGplpmSXoB9xmY10gXf8eAg7CY1WNssbchU9crnZdiRR8xMLAQd7HFXbBAioarJ1NrlfE9LwWm3PJ5N4aZB8LD2lLCwHit5uHewWGrXqmUr3+JEva5UZvcj+TooBYlhEU4qw1CsgjC3jyYJPvB0f4iyK9aQT7Ng8n0Yy1KcG0QDlrD8KY57LYbwxcSostP3w+vO91OP6iR/LgZTG7mQUgag5BMR3mv2T8l8/7Zt0WQ3+wNulfNIDxu9U9lY3h0YQZHF3LQdl3koE2uyL992AxUy9ORi+3EHi/WbT2QFQqsaF1lI0aJa5ou5jiXAs+NSyT3OMQUe+cM27HUvCMXkbnPsIZoEuj5jwPhKpE8DZ9K8Tx55KOgHfauj7d3oT3DlOERA+RbncFv64z8W0RSIFOT8VLWEE1VKeiUXogyzarPamsUaE6NKcfgoLFkMejCUZRDZJeqsJMoxuGg7UylKcd6GZWq21cauLQQEQ3YQhxhu44Ve7F9ihS26TpE4/V3puK1gKE5oLvi7j6jGuJzrDEHC7po+u7ReQlgV0s12jXESvQJJP8qrlOxfFuQm+h2SOh9aZxKmTD40NV0BrtBslKMSsXosuTxnoaKq07KAds04yOBKduw2L/ltqGAHbJ9sttQQDnnym9vzHeT6O799vcZXaZYw7mkwu6WUqmrCt3/nOyfcbp7/AkqCFoM2QoAAA=="
        /></Footer>{/* END_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_files
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: >-
            Which relations should be returned in expanded form. Multiple relation names should be comma separated
            without spaces.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/FilesIdGetParametersExpandSchemaItems'
        - name: include_remote_data
          in: query
          description: Whether to include the original data Merge fetched from the third-party to produce these models.
          required: false
          schema:
            type: boolean
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
  /filestorage/v1/files/{id}/download:
    get:
      operationId: download-retrieve
      summary: Download Retrieve
      description: >-
        Returns the `File` content with the given `id` as a stream of bytes.{/*
        BEGIN_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget
        requestType="GET"
        data="H4sIAAAAAAAAA+2T207bQBCGX6Xay8ixG0KKsFRVCeGQqHEoGFSKkLVZT+xN9sTuOgcj3r2yY0jSckGlQC/aO+/szL+e+eZ/QARbSKReIh+NKQNjpcYJIAdxGQNDPjqhrDhiRQPMYTstmu0hB5lMKaktxCcUWGzONIyRjzwOOoF6JuiYQuxtVHlUWEg0tlQK4z1X18dlOXIQo2IKcZsQmQn7Cr1Vfh2vCn45Go9RY5GDFDbGplpmSXoB9xmY10gXf8eAg7CY1WNssbchU9crnZdiRR8xMLAQd7HFXbBAioarJ1NrlfE9LwWm3PJ5N4aZB8LD2lLCwHit5uHewWGrXqmUr3+JEva5UZvcj+TooBYlhEU4qw1CsgjC3jyYJPvB0f4iyK9aQT7Ng8n0Yy1KcG0QDlrD8KY57LYbwxcSostP3w+vO91OP6iR/LgZTG7mQUgag5BMR3mv2T8l8/7Zt0WQ3+wNulfNIDxu9U9lY3h0YQZHF3LQdl3koE2uyL992AxUy9ORi+3EHi/WbT2QFQqsaF1lI0aJa5ou5jiXAs+NSyT3OMQUe+cM27HUvCMXkbnPsIZoEuj5jwPhKpE8DZ9K8Tx55KOgHfauj7d3oT3DlOERA+RbncFv64z8W0RSIFOT8VLWEE1VKeiUXogyzarPamsUaE6NKcfgoLFkMejCUZRDZJeqsJMoxuGg7UylKcd6GZWq21cauLQQEQ3YQhxhu44Ve7F9ihS26TpE4/V3puK1gKE5oLvi7j6jGuJzrDEHC7po+u7ReQlgV0s12jXESvQJJP8qrlOxfFuQm+h2SOh9aZxKmTD40NV0BrtBslKMSsXosuTxnoaKq07KAds04yOBKduw2L/ltqGAHbJ9sttQQDnnym9vzHeT6O799vcZXaZYw7mkwu6WUqmrCt3/nOyfcbp7/AkqCFoM2QoAAA=="
        /></Footer>{/* END_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_files
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: include_shell_data
          in: query
          description: >-
            Whether to include shell records. Shell records are empty records (they may contain some metadata but all
            other fields are null).
          required: false
          schema:
            type: boolean
        - name: mime_type
          in: query
          description: >-
            If provided, specifies the export format of the file to be downloaded. For information on supported export
            formats, please refer to our <a
            href='https://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
            target='_blank'>export format help center article</a>.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /filestorage/v1/files/{id}/download/request-meta:
    get:
      operationId: download-request-meta-retrieve
      summary: Download Request Meta Retrieve
      description: >-
        Returns metadata to construct an authenticated file download request for a singular file, allowing you to
        download file directly from the third-party. For information on our download process please refer to our <a
        href='https://help.merge.dev/articles/10644317' target='_blank'>direct file download help center article</a>.{/*
        BEGIN_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget
        requestType="GET"
        data="H4sIAAAAAAAAA+2T207bQBCGX6Xay8ixG0KKsFRVCeGQqHEoGFSKkLVZT+xN9sTuOgcj3r2yY0jSckGlQC/aO+/szL+e+eZ/QARbSKReIh+NKQNjpcYJIAdxGQNDPjqhrDhiRQPMYTstmu0hB5lMKaktxCcUWGzONIyRjzwOOoF6JuiYQuxtVHlUWEg0tlQK4z1X18dlOXIQo2IKcZsQmQn7Cr1Vfh2vCn45Go9RY5GDFDbGplpmSXoB9xmY10gXf8eAg7CY1WNssbchU9crnZdiRR8xMLAQd7HFXbBAioarJ1NrlfE9LwWm3PJ5N4aZB8LD2lLCwHit5uHewWGrXqmUr3+JEva5UZvcj+TooBYlhEU4qw1CsgjC3jyYJPvB0f4iyK9aQT7Ng8n0Yy1KcG0QDlrD8KY57LYbwxcSostP3w+vO91OP6iR/LgZTG7mQUgag5BMR3mv2T8l8/7Zt0WQ3+wNulfNIDxu9U9lY3h0YQZHF3LQdl3koE2uyL992AxUy9ORi+3EHi/WbT2QFQqsaF1lI0aJa5ou5jiXAs+NSyT3OMQUe+cM27HUvCMXkbnPsIZoEuj5jwPhKpE8DZ9K8Tx55KOgHfauj7d3oT3DlOERA+RbncFv64z8W0RSIFOT8VLWEE1VKeiUXogyzarPamsUaE6NKcfgoLFkMejCUZRDZJeqsJMoxuGg7UylKcd6GZWq21cauLQQEQ3YQhxhu44Ve7F9ihS26TpE4/V3puK1gKE5oLvi7j6jGuJzrDEHC7po+u7ReQlgV0s12jXESvQJJP8qrlOxfFuQm+h2SOh9aZxKmTD40NV0BrtBslKMSsXosuTxnoaKq07KAds04yOBKduw2L/ltqGAHbJ9sttQQDnnym9vzHeT6O799vcZXaZYw7mkwu6WUqmrCt3/nOyfcbp7/AkqCFoM2QoAAA=="
        /></Footer>{/* END_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_files
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: mime_type
          in: query
          description: If provided, specifies the export format of the file to be downloaded.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadRequestMeta'
  /filestorage/v1/files/download/request-meta:
    get:
      operationId: download-request-meta-list
      summary: Download Request Meta List
      description: >-
        Returns metadata to construct authenticated file download requests, allowing you to download files directly from
        the third-party.{/* BEGIN_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+2T207bQBCGX6Xay8ixG0KKsFRVCeGQqHEoGFSKkLVZT+xN9sTuOgcj3r2yY0jSckGlQC/aO+/szL+e+eZ/QARbSKReIh+NKQNjpcYJIAdxGQNDPjqhrDhiRQPMYTstmu0hB5lMKaktxCcUWGzONIyRjzwOOoF6JuiYQuxtVHlUWEg0tlQK4z1X18dlOXIQo2IKcZsQmQn7Cr1Vfh2vCn45Go9RY5GDFDbGplpmSXoB9xmY10gXf8eAg7CY1WNssbchU9crnZdiRR8xMLAQd7HFXbBAioarJ1NrlfE9LwWm3PJ5N4aZB8LD2lLCwHit5uHewWGrXqmUr3+JEva5UZvcj+TooBYlhEU4qw1CsgjC3jyYJPvB0f4iyK9aQT7Ng8n0Yy1KcG0QDlrD8KY57LYbwxcSostP3w+vO91OP6iR/LgZTG7mQUgag5BMR3mv2T8l8/7Zt0WQ3+wNulfNIDxu9U9lY3h0YQZHF3LQdl3koE2uyL992AxUy9ORi+3EHi/WbT2QFQqsaF1lI0aJa5ou5jiXAs+NSyT3OMQUe+cM27HUvCMXkbnPsIZoEuj5jwPhKpE8DZ9K8Tx55KOgHfauj7d3oT3DlOERA+RbncFv64z8W0RSIFOT8VLWEE1VKeiUXogyzarPamsUaE6NKcfgoLFkMejCUZRDZJeqsJMoxuGg7UylKcd6GZWq21cauLQQEQ3YQhxhu44Ve7F9ihS26TpE4/V3puK1gKE5oLvi7j6jGuJzrDEHC7po+u7ReQlgV0s12jXESvQJJP8qrlOxfFuQm+h2SOh9aZxKmTD40NV0BrtBslKMSsXosuTxnoaKq07KAds04yOBKduw2L/ltqGAHbJ9sttQQDnnym9vzHeT6O799vcZXaZYw7mkwu6WUqmrCt3/nOyfcbp7/AkqCFoM2QoAAA=="
        /></Footer>{/* END_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_files
      parameters:
        - name: created_after
          in: query
          description: If provided, will only return objects created after this datetime.
          required: false
          schema:
            type: string
        - name: created_before
          in: query
          description: If provided, will only return objects created before this datetime.
          required: false
          schema:
            type: string
        - name: cursor
          in: query
          description: The pagination cursor value.
          required: false
          schema:
            type: string
        - name: ids
          in: query
          description: If provided, will only return objects with the given IDs. Comma-separated list of strings.
          required: false
          schema:
            type: array
            items:
              type: string
        - name: include_deleted_data
          in: query
          description: >-
            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](https://docs.merge.dev/integrations/hris/supported-features/).
          required: false
          schema:
            type: boolean
        - name: mime_types
          in: query
          description: >-
            A comma-separated list of preferred MIME types in order of priority. If supported by the third-party
            provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type
            is PDF. To see supported MIME types by file type, refer to our <a
            href='https://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
            target='_blank'>export format help center article</a>.
          required: false
          schema:
            type: string
        - name: modified_after
          in: query
          description: If provided, will only return objects modified after this datetime.
          required: false
          schema:
            type: string
        - name: modified_before
          in: query
          description: If provided, will only return objects modified before this datetime.
          required: false
          schema:
            type: string
        - name: order_by
          in: query
          description: >-
            Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at,
            modified_at, -modified_at.
          required: false
          schema:
            $ref: '#/components/schemas/FilesDownloadRequestMetaGetParametersOrderBy'
        - name: page_size
          in: query
          description: Number of results to return per page. The maximum limit is 100.
          required: false
          schema:
            type: integer
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDownloadRequestMetaList'
  /filestorage/v1/files/meta/post:
    get:
      operationId: meta-post-retrieve
      summary: Meta Post Retrieve
      description: >-
        Returns metadata for `FileStorageFile` POSTs.{/* BEGIN_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+2T207bQBCGX6Xay8ixG0KKsFRVCeGQqHEoGFSKkLVZT+xN9sTuOgcj3r2yY0jSckGlQC/aO+/szL+e+eZ/QARbSKReIh+NKQNjpcYJIAdxGQNDPjqhrDhiRQPMYTstmu0hB5lMKaktxCcUWGzONIyRjzwOOoF6JuiYQuxtVHlUWEg0tlQK4z1X18dlOXIQo2IKcZsQmQn7Cr1Vfh2vCn45Go9RY5GDFDbGplpmSXoB9xmY10gXf8eAg7CY1WNssbchU9crnZdiRR8xMLAQd7HFXbBAioarJ1NrlfE9LwWm3PJ5N4aZB8LD2lLCwHit5uHewWGrXqmUr3+JEva5UZvcj+TooBYlhEU4qw1CsgjC3jyYJPvB0f4iyK9aQT7Ng8n0Yy1KcG0QDlrD8KY57LYbwxcSostP3w+vO91OP6iR/LgZTG7mQUgag5BMR3mv2T8l8/7Zt0WQ3+wNulfNIDxu9U9lY3h0YQZHF3LQdl3koE2uyL992AxUy9ORi+3EHi/WbT2QFQqsaF1lI0aJa5ou5jiXAs+NSyT3OMQUe+cM27HUvCMXkbnPsIZoEuj5jwPhKpE8DZ9K8Tx55KOgHfauj7d3oT3DlOERA+RbncFv64z8W0RSIFOT8VLWEE1VKeiUXogyzarPamsUaE6NKcfgoLFkMejCUZRDZJeqsJMoxuGg7UylKcd6GZWq21cauLQQEQ3YQhxhu44Ve7F9ihS26TpE4/V3puK1gKE5oLvi7j6jGuJzrDEHC7po+u7ReQlgV0s12jXESvQJJP8qrlOxfFuQm+h2SOh9aZxKmTD40NV0BrtBslKMSsXosuTxnoaKq07KAds04yOBKduw2L/ltqGAHbJ9sttQQDnnym9vzHeT6O799vcZXaZYw7mkwu6WUqmrCt3/nOyfcbp7/AkqCFoM2QoAAA=="
        /></Footer>{/* END_FILESTORAGE_FILE_FETCH_SUPPORTED_FIELDS */}
      tags:
        - subpackage_files
      parameters:
        - name: Authorization
          in: header
          description: Token-based authentication with required prefix "Bearer"
          required: true
          schema:
            type: string
        - name: X-Account-Token
          in: header
          description: Token identifying the end user.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaResponse'
  /filestorage/v1/folders:
    get:
      operationId: list
      summary: List
      description: >-
        Returns a list of `Folder` objects.{/* BEGIN_FILESTORAGE_FOLDER_FETCH_SUPPORTED_FIELDS
        */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET"
        data="H4sIAAAAAAAAA+2Tb2/aMBDGv8rklygko5RVjTRNUPoHNELXptW6qrJMfCQGxw62AzRVv/uUBAp0vOgqhjZprxKffY9997vnCQXEQCjVI3LRkHHQRioSArJQLClw5KIzySkoZCGSMI/EsHkQTw+QhXSaJFIZoGcMONUXCobIRU4MKoRqKtiQAXXWshwmDISKGCaFdl6yq8MiHVmIMzEG2gwCmQrzBr3yfJWUCa+W2uFMG2ShhGhtIiXTMLqCSQr6LdL56zjEIAzhVUoMcdZkqqrU2RbL66DAwQBtE0PaYCDIC15cGRmTaNdxIuCJXVxvU5g6IByiDAs4aKdRPz44Om5UFyrF7V9wyD/XKqPJQA6OKjgMOCZppecHc8/vzLxReOidHM697KbhZePMG40/VnBIKj2/1+j7d/V+u1nrbzmArz99P75ttVtdrxJkp3VvdDfz/KDW84Px

# --- truncated at 32 KB (167 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/openapi/merge-file-storage-api-openapi.yaml
Merge File Storage API

Documentation

Specifications

Examples

Schemas & Data

Other Resources

OpenAPI Specification
