HubSpot Files API

openapi: 3.0.1
info:
  title: HubSpot Files
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
- url: https://api.hubapi.com
tags:
- name: Files
- name: Folders
paths:
  /files/2026-03/files:
    post:
      tags:
      - Files
      summary: Upload file
      description: Upload a single file with content specified in request body.
      operationId: post-/files/2026-03/files_upload
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                charsetHunch:
                  type: string
                file:
                  type: string
                  format: binary
                fileName:
                  type: string
                folderId:
                  type: string
                folderPath:
                  type: string
                options:
                  type: string
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
  /files/2026-03/files/import-from-url/async:
    post:
      tags:
      - Files
      summary: Import file from URL
      description: Asynchronously imports the file at the given URL into the file manager.
      operationId: post-/files/2026-03/files/import-from-url/async_importFromUrl
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportFromUrlInput'
        required: true
      responses:
        '202':
          description: accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportFromUrlTaskLocator'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
  /files/2026-03/files/import-from-url/async/tasks/{taskId}/status:
    get:
      tags:
      - Files
      summary: Check import status
      description: Check the status of requested import.
      operationId: get-/files/2026-03/files/import-from-url/async/tasks/{taskId}/status_checkImport
      parameters:
      - name: taskId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileActionResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
  /files/2026-03/files/search:
    get:
      tags:
      - Files
      summary: Search files
      description: Search through files in the file manager. Does not display hidden or archived files.
      operationId: get-/files/2026-03/files/search_doSearch
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource will be returned as
          the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: allowsAnonymousAccess
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: before
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: createdAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdAtGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdAtLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: encoding
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: expiresAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: expiresAtGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: expiresAtLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: extension
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: fileMd5
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: height
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: heightGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: heightLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: idGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: idLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: ids
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: isUsableInContent
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: parentFolderIds
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: path
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: size
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: sizeGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: sizeLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: sort
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: type
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: updatedAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAtGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAtLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: url
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: width
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: widthGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: widthLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseFile'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
  /files/2026-03/files/stat/{path}:
    get:
      tags:
      - Files
      summary: Retrieve file by path
      description: Retrieve a file by its path.
      operationId: get-/files/2026-03/files/stat/{path}_getMetadata
      parameters:
      - name: path
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: .+
          type: string
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileStat'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
  /files/2026-03/files/{fileId}:
    get:
      tags:
      - Files
      summary: Retrieve file by ID
      description: Retrieve a file by its ID.
      operationId: get-/files/2026-03/files/{fileId}_getById
      parameters:
      - name: fileId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
    put:
      tags:
      - Files
      summary: Replace file
      description: Replace existing file data with new file data. Can be used to change image content
        without having to upload a new file and update all references.
      operationId: put-/files/2026-03/files/{fileId}_replace
      parameters:
      - name: fileId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                charsetHunch:
                  type: string
                file:
                  type: string
                  format: binary
                options:
                  type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
    delete:
      tags:
      - Files
      summary: Delete file by ID
      description: Delete a file by ID
      operationId: delete-/files/2026-03/files/{fileId}_archive
      parameters:
      - name: fileId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.delete
    patch:
      tags:
      - Files
      summary: Update file properties
      description: Update properties of file by ID.
      operationId: patch-/files/2026-03/files/{fileId}_updateProperties
      parameters:
      - name: fileId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileUpdateInput'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
  /files/2026-03/files/{fileId}/gdpr-delete:
    delete:
      tags:
      - Files
      summary: GDPR-delete file
      description: Delete a file in accordance with GDPR regulations.
      operationId: delete-/files/2026-03/files/{fileId}/gdpr-delete_delete
      parameters:
      - name: fileId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.delete
  /files/2026-03/files/{fileId}/signed-url:
    get:
      tags:
      - Files
      summary: Get signed URL to access private file
      description: Generates signed URL that allows temporary access to a private file.
      operationId: get-/files/2026-03/files/{fileId}/signed-url_getSignedUrl
      parameters:
      - name: fileId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      - name: expirationSeconds
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - icon
          - medium
          - preview
          - thumb
      - name: upscale
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignedUrl'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
  /files/2026-03/folders:
    post:
      tags:
      - Files
      summary: Create folder
      description: Creates a folder.
      operationId: post-/files/2026-03/folders_create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FolderInput'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
  /files/2026-03/folders/search:
    get:
      tags:
      - Folders
      summary: Search folders
      description: Search for folders. Does not contain hidden or archived folders.
      operationId: get-/files/2026-03/folders/search_doSearch
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource will be returned as
          the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: before
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: createdAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdAtGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdAtLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: idGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: idLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: ids
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: parentFolderIds
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int64
      - name: path
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: updatedAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAtGte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAtLte
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseFolder'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
  /files/2026-03/folders/update/async:
    post:
      tags:
      - Folders
      summary: Update folder properties
      description: Update properties of folder by given ID. This action happens asynchronously and will
        update all of the folder's children as well.
      operationId: post-/files/2026-03/folders/update/async_updatePropertiesRecursively
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FolderUpdateInputWithId'
        required: true
      responses:
        '202':
          description: accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderUpdateTaskLocator'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
  /files/2026-03/folders/update/async/tasks/{taskId}/status:
    get:
      tags:
      - Folders
      summary: Check folder update status
      description: Check status of folder update. Folder updates happen asynchronously.
      operationId: get-/files/2026-03/folders/update/async/tasks/{taskId}/status_checkUpdateStatus
      parameters:
      - name: taskId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderActionResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
  /files/2026-03/folders/{folderId}:
    get:
      tags:
      - Folders
      summary: Retrieve folder by ID
      description: Retrieve a folder by its ID.
      operationId: get-/files/2026-03/folders/{folderId}_getById
      parameters:
      - name: folderId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
    delete:
      tags:
      - Folders
      summary: Delete folder by ID
      description: Delete folder by ID.
      operationId: delete-/files/2026-03/folders/{folderId}_archive
      parameters:
      - name: folderId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.delete
    patch:
      tags:
      - Folders
      summary: Update folder properties by folder ID
      description: Update a folder's properties, identified by folder ID.
      operationId: patch-/files/2026-03/folders/{folderId}_updateProperties
      parameters:
      - name: folderId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: \d+
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FolderUpdateInput'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.write
  /files/2026-03/folders/{folderPath}:
    get:
      tags:
      - Folders
      summary: Retrieve folder by path
      description: Retrieve a folder, identified by its path.
      operationId: get-/files/2026-03/folders/{folderPath}_getByPath
      parameters:
      - name: folderPath
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: .+
          type: string
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files
      - oauth2:
        - files.read
      - oauth2:
        - files.ui_hidden.read
    delete:
      tags:
      - Folders
      summary: Delete folder by path
      description: Delete a folder, identified by its path.
      operationId: delete-/files/2026-03/folders/{folderPath}_archiveByPath
      parameters:
      - name: folderPath
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          pattern: .+
          type: string
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - files.ui_hidden.write
      - oauth2:
        - files
      - oauth2:
        - files.delete
components:
  schemas:
    CollectionResponseFile:
      required:
      - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/File'
    CollectionResponseFolder:
      required:
      - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/Folder'
    Error:
      required:
      - category
      - correlationId
      - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}'
        correlationId:
          type: string
          description: A unique identifier for the request. Include this value with any error reports
            or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: A map of link names to associated URIs containing documentation about the error
            or recommended remediation steps
        message:
          type: string
          description: A human readable message describing the error along with remediation steps where
            appropriate
          example: An error occurred
        subCategory:
          type: string
          description: A specific category that contains more specific detail about the error
      description: Represents

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/openapi/hubspot-files-files-api-openapi.yml