Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot File Extraction API

Operations for extracting zip archives in the developer file system

HubSpot File Extraction API is one of 93 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 652 JSON Schema definitions.

Tagged areas include File Extraction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.hubapi.com.

2 operations 2 paths 5 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

HubSpot File Extraction API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

File Extraction 2

Operations for extracting zip archives in the developer file system

POST
/cms/v3/source-code/extract/async
Hubspot Extract a Zip Archive
extractZipFileAsync body → 202default
GET
/cms/v3/source-code/extract/async/tasks/{taskId}/status
Hubspot Get Extraction Task Status
getExtractionTaskStatus 1 param → 200default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Error (7 properties), ActionResponse (5 properties), ErrorDetail (5 properties), TaskLocator (2 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
Detailed error information
5 properties 1 required
ActionResponse
object
Response for asynchronous action status
5 properties 3 required
Error
object
Standard error response
7 properties 3 required
FileExtractRequest
object
Request body for zip file extraction
1 property 1 required
TaskLocator
object
Locator for an asynchronous task
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-file-extraction-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot Posts API
HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API