Upload and manage files.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.hubapi.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Upload and manage files.
| method | path | what the vendor says it does |
|---|---|---|
POST | /files/v3/files | Upload file Upload a single file with content specified in request body. Files |
POST | /files/v3/files/import-from-url/async | Import a file from a URL into the file manager. Asynchronously imports the file at the given URL into the file |
GET | /files/v3/files/import-from-url/async/tasks/{taskId}/status | Check import status. Check the status of requested import. Files |
GET | /files/v3/files/search | Search files Search through files in the file manager. Does not display hidden or archived files. Files |
GET | /files/v3/files/{fileId} | Get file. Get file by ID. Files |
PUT | /files/v3/files/{fileId} | Replace file. Replace existing file data with new file data. Can be used to change image content without havin |
PATCH | /files/v3/files/{fileId} | update file properties Update properties of file by ID. Files |
DELETE | /files/v3/files/{fileId} | Delete file Delete file by ID Files |
DELETE | /files/v3/files/{fileId}/gdpr-delete | GDPR delete GDRP delete file Files |
GET | /files/v3/files/{fileId}/signed-url | Get signed URL to access private file. Generates signed URL that allows temporary access to a private file. Fi |
POST | /files/v3/folders | Create folder. Creates a folder. Folders |
GET | /files/v3/folders/search | Search folders Search for folders. Does not contain hidden or archived folders. Folders |
POST | /files/v3/folders/update/async | Update folder properties Update properties of folder by given ID. This action happens asynchronously and will |
GET | /files/v3/folders/update/async/tasks/{taskId}/status | Check folder update status. Check status of folder update. Folder updates happen asynchronously. Folders |
GET | /files/v3/folders/{folderId} | Get folder Get folder by ID Folders |
DELETE | /files/v3/folders/{folderId} | Delete folder. Delete folder by ID. Folders |
GET | /files/v3/folders/{folderPath} | Get folder. Get folder by path. Folders |
DELETE | /files/v3/folders/{folderPath} | Delete folder. Delete folder by path. Folders |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/files/v3/files
Create custom workflow actions
| method | path | what the vendor says it does |
|---|---|---|
POST | /automation/v4/actions/callbacks/complete | Complete a batch of callbacks Completes the given action callbacks. Callbacks |
POST | /automation/v4/actions/callbacks/{callbackId}/complete | Complete a callback Completes the given action callback. Callbacks |
GET | /automation/v4/actions/{appId} | Get all custom actions Returns a list of all custom workflow actions. Definitions |
POST | /automation/v4/actions/{appId} | Create new custom action Creates a new custom workflow action. Definitions |
GET | /automation/v4/actions/{appId}/{definitionId} | Get a custom action Returns a single custom workflow action with the specified ID. Definitions |
PATCH | /automation/v4/actions/{appId}/{definitionId} | Update a custom action Updates a custom workflow action with new values for the specified fields. Definitions |
DELETE | /automation/v4/actions/{appId}/{definitionId} | Archive a custom action Archives a single custom workflow action with the specified ID. Workflows that current |
GET | /automation/v4/actions/{appId}/{definitionId}/functions | Get all custom action functions Returns a list of all functions that are associated with the given custom work |
GET | /automation/v4/actions/{appId}/{definitionId}/functions/{functionType} | Get a custom action function Returns the given function for a custom workflow action. Functions |
PUT | /automation/v4/actions/{appId}/{definitionId}/functions/{functionType} | Create or replace a custom action function Creates or replaces a function for a custom workflow action. Functi |
DELETE | /automation/v4/actions/{appId}/{definitionId}/functions/{functionType} | Delete a custom action function Delete a function for a custom workflow action. This will remove the function |
GET | /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId} | Get a custom action function Returns the given function for a custom workflow action. Functions |
PUT | /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId} | Create or replace a custom action function Creates or replaces a function for a custom workflow action. Functi |
DELETE | /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId} | Delete a custom action function Delete a function for a custom workflow action. This will remove the function |
GET | /automation/v4/actions/{appId}/{definitionId}/revisions | Get all revisions for a custom action Returns a list of revisions for a custom workflow action. Revisions |
GET | /automation/v4/actions/{appId}/{definitionId}/revisions/{revisionId} | Get a revision for a custom action Returns the given version of a custom workflow action. Revisions |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/automation/v4/actions
Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.
| method | path | what the vendor says it does |
|---|---|---|
GET | /crm/v3/extensions/cards/sample-response | Get sample card detail response Returns an example card detail response. This is the payload with displayed de |
GET | /crm/v3/extensions/cards/{appId} | Get all cards Returns a list of cards for a given app. Cards |
POST | /crm/v3/extensions/cards/{appId} | Create a new card Defines a new card that will become active on an account when this app is installed. Cards |
GET | /crm/v3/extensions/cards/{appId}/{cardId} | Get a card. Returns the definition for a card with the given ID. Cards |
PATCH | /crm/v3/extensions/cards/{appId}/{cardId} | Update a card Update a card definition with new details. Cards |
DELETE | /crm/v3/extensions/cards/{appId}/{cardId} | Delete a card Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for t |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/extensions/sales-objects/v1/object-type
Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining to a specific topic, brand, or an entire HubSpot account.
| method | path | what the vendor says it does |
|---|---|---|
GET | /communication-preferences/v3/definitions | Get subscription definitions Get a list of all subscription definitions for the portal Definition |
GET | /communication-preferences/v3/status/email/{emailAddress} | Get subscription statuses for a contact Returns a list of subscriptions and their status for a given contact. |
POST | /communication-preferences/v3/subscribe | Subscribe a contact Subscribes a contact to the given subscription type. This API is not valid to use for subs |
POST | /communication-preferences/v3/unsubscribe | Unsubscribe a contact Unsubscribes a contact from the given subscription type. This API is not valid to use fo |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/communication-preferences/v3
These APIs allow you to interact with HubSpot's Marketing Events Extension. It allows you to: * Create, Read or update Marketing Event information in HubSpot * Specify whether a HubSpot contact has registered, attended or cancelled a registration to a Marketing Event. * Specify a URL that can be called to get the details of a Marketing Event.
| method | path | what the vendor says it does |
|---|---|---|
POST | /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create | Record Record a subscription state between multiple HubSpot contacts and a marketing event, using HubSpot cont |
POST | /marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create | Record Record a subscription state between multiple HubSpot contacts and a marketing event, using contact emai |
GET | /marketing/v3/marketing-events/events/search | Search for marketing events Search for marketing events that have an event id that starts with the query strin |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/marketing/v3/marketing-events-beta
Domains, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /cms/v3/domains/ | Get current domains Returns all existing domains that have been created. Results can be limited and filtered b |
GET | /cms/v3/domains/{domainId} | Get a single domain Returns a single domains with the id specified. Domains |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/cms/v3/domains
HTTP API for triggering instances of custom behavioral events
| method | path | what the vendor says it does |
|---|---|---|
POST | /events/v3/send | Sends Custom Behavioral Event Endpoint to send an instance of a behavioral event Behavioral_Events_Tracking |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/events/v3/send
API for accessing CRM object events.
| method | path | what the vendor says it does |
|---|---|---|
GET | /events/v3/events | Returns a collection of events matching a query. Events |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/events/v3/events
The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.
| method | path | what the vendor says it does |
|---|---|---|
POST | /conversations/v3/visitor-identification/tokens/create | Generate a token Generates a new visitor identification token. This token will be unique every time this endpo |
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/conversations/v3/visitor-identification
Retrieve Business Unit information.
| method | path | what the vendor says it does |
|---|
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/business-units/v3
Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the changes at a specified target URL. There can only be one target URL for receiving event notifications per app.
| method | path | what the vendor says it does |
|---|
specification origin: https://api.hubspot.com/api-catalog-public/v1/apis/webhooks/v3
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.