HubSpot: Retrieve status

← Files operations · Get started

Operation hubspot.files_get_file_status

Provider route: GET /files/2026-09/files/import-from-url/async/tasks/{taskId}/status. 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"]["getFileStatus"]>[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.getFileStatus(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.get_file_status(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.taskId	string	Required within parent

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 Retrieve status — response body

Referenced models: Retrieve status — response body

Schemas

Retrieve status — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the file action was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the file action.
errors[]	Model	Each item	Expand Retrieve status — response body — errors item
links	object	Optional	A map of link names to associated URIs, providing additional information about the file action. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the file action, represented as an integer. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the file action was requested, in ISO 8601 format. Format: date-time
result	Model	Optional	Expand Upload file — response body
startedAt	string	Required within parent	The date and time when the file action started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the file action. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING
taskId	string	Required within parent	The unique identifier for the task associated with the file action.

Referenced models: Retrieve status — response body — errors item, Upload file — response body

Retrieve status — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string that categorizes the type of error.
context	object	Required within parent	An object containing additional context about the error condition, with properties as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects that provide further information about the error.
errors[]	Model	Each item	Expand Retrieve status — response body — errors item errors item
id	string	Optional	A string representing a unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs with documentation or remediation steps for the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific details about the error category.

Referenced models: Retrieve status — response body — errors item errors item

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]+)?$

Retrieve status — response body — errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail.
context	object	Optional	Context about the error condition, represented as an object with additional properties that are arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate. It is a string.
subCategory	string	Optional	A specific category that contains more specific detail about the error. This is a string.

Policy, approvals and errors

SDK function policy ID: hubspot.files_get_file_status. Catalog operation: files_get_file_status. 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