HubSpot: Search files

← Files operations · Get started

Operation hubspot.files_search_files

Provider route: GET /files/2026-09/files/search. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["files"]["searchFiles"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.files.searchFiles(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.files.search_files(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.allowsAnonymousAccess	boolean	Optional
query.before	string	Optional
query.createdAt	string	Optional	Format: date-time
query.createdAtGte	string	Optional	Format: date-time
query.createdAtLte	string	Optional	Format: date-time
query.encoding	string	Optional
query.expiresAt	string	Optional	Format: date-time
query.expiresAtGte	string	Optional	Format: date-time
query.expiresAtLte	string	Optional	Format: date-time
query.extension	string	Optional
query.fileMd5	string	Optional
query.height	integer	Optional	Format: int32
query.heightGte	integer	Optional	Format: int32
query.heightLte	integer	Optional	Format: int32
query.idGte	integer	Optional	Format: int64
query.idLte	integer	Optional	Format: int64
query.ids	array	Optional
query.ids[]	integer	Each item	Format: int64
query.isUsableInContent	boolean	Optional
query.limit	integer	Optional	Format: int32
query.name	string	Optional
query.parentFolderIds	array	Optional
query.parentFolderIds[]	integer	Each item	Format: int64
query.path	string	Optional
query.properties	array	Optional
query.properties[]	string	Each item
query.size	integer	Optional	Format: int64
query.sizeGte	integer	Optional	Format: int64
query.sizeLte	integer	Optional	Format: int64
query.sort	array	Optional
query.sort[]	string	Each item
query.type	string	Optional
query.updatedAt	string	Optional	Format: date-time
query.updatedAtGte	string	Optional	Format: date-time
query.updatedAtLte	string	Optional	Format: date-time
query.url	string	Optional
query.width	integer	Optional	Format: int32
query.widthGte	integer	Optional	Format: int32
query.widthLte	integer	Optional	Format: int32

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Search files — response body

Referenced models: Search files — response body

Schemas

Search files — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Search files — response body — paging
results	array	Required within parent	An array of file objects, each representing a file with its associated metadata.
results[]	Model	Each item	Expand Upload file — response body

Referenced models: Search files — response body — paging, Upload file — response body

Search files — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Search files — response body — paging next
prev	Model	Optional	Expand Search files — response body — paging prev

Referenced models: Search files — response body — paging next, Search files — response body — paging prev

Upload file — response body

Field	Type	Presence	Description and constraints
$	object	Root
access	string	Optional	The access level of the file, represented as a string. Valid values include 'PUBLIC_INDEXABLE', 'PUBLIC_NOT_INDEXABLE', 'HIDDEN_INDEXABLE', 'HIDDEN_NOT_INDEXABLE', 'HIDDEN_PRIVATE', 'PRIVATE', 'HIDDEN_SENSITIVE', and 'SENSITIVE'. Known values: HIDDEN_INDEXABLE, HIDDEN_NOT_INDEXABLE, HIDDEN_PRIVATE, HIDDEN_SENSITIVE, PRIVATE, PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, SENSITIVE
archived	boolean	Required within parent	A boolean indicating whether the file is archived.
archivedAt	string	Optional	The date and time when the file was deleted, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the file was created, in ISO 8601 format. Format: date-time
defaultHostingUrl	string	Optional	The static cdn URL where the file is hosted.
encoding	string	Optional	The encoding of the file.
expiresAt	JSON	Optional
expiresAt (anyOf 1)	integer	Alternative	The expiration epoch timestamp, if set. Format: int64
expiresAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
extension	string	Optional	The file extension.
fileMd5	string	Optional	The MD5 hash of the file.
height	JSON	Optional
height (anyOf 1)	integer	Alternative	The height of the file in pixels, applicable if the file is an image or video. Format: int32
height (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	The ID of the file.
isUsableInContent	boolean	Optional	A boolean indicating whether the file can be used in content.
name	string	Optional	The name of the file.
parentFolderId	string	Optional	The unique identifier of the parent folder containing the file, represented as a string.
path	string	Optional	The path of the file within the file manager.
size	JSON	Optional
size (anyOf 1)	integer	Alternative	The size of the file in bytes. Format: int64
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sourceGroup	string	Optional	The source group of the file, with possible values including 'UNKNOWN', 'CONTENT', 'FORMS', 'CONVERSATIONS', and 'UI_EXTENSIONS'. Known values: CONTENT, CONVERSATIONS, FORMS, UI_EXTENSIONS, UNKNOWN
type	string	Optional	The type of the file. Values include: IMG, DOCUMENT, AUDIO, MOVIE, OTHER.
updatedAt	string	Required within parent	The date and time when the file was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL where the file can be accessed, represented as a string.
width	JSON	Optional
width (anyOf 1)	integer	Alternative	The width of the file in pixels, applicable if the file is an image or video. Format: int32
width (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Search files — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used to retrieve the next page of results.
link	string	Optional	A string URL that provides the link to access the next page of results.

Search files — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token representing the cursor for the previous page of results.
link	string	Optional	A string URL that provides a link to the previous page of results.

Policy, approvals and errors

SDK function policy ID: hubspot.files_search_files. Catalog operation: files_search_files. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["files.read", "files.sensitive.read", "files.ui_hidden.read"]

Official provider source