# HubSpot docs: APIs 2026-09 ## 2026-09 - [2026-09 API reference](https://developers.hubspot.com/docs/api-reference/latest/overview.md): Reference documentation for HubSpot's 2026-09 APIs - [Sunsetted and deprecated APIs](https://developers.hubspot.com/docs/api-reference/latest/deprecated-apis.md): Learn about the APIs that HubSpot has sunsetted and deprecated. - [Error handling](https://developers.hubspot.com/docs/api-reference/latest/error-handling.md): Learn how to handle common API errors when developing with HubSpot's APIs. - [APIs / 2026-09 / CMS (220 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/cms.txt): Documentation for APIs / 2026-09 / CMS. - [APIs / 2026-09 / CRM (635 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm.txt): Documentation for APIs / 2026-09 / CRM. - [APIs / 2026-09 / Marketing (79 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/marketing.txt): Documentation for APIs / 2026-09 / Marketing. ### Account & Settings #### Account information - [Account information API](https://developers.hubspot.com/docs/api-reference/latest/account/account-information/guide.md): HubSpot's account information API endpoints provide account configuration and usage data. - [Retrieve account details](https://developers.hubspot.com/docs/api-reference/latest/account/account-information/get-account-details.md): Retrieve detailed information about the account associated with the HubSpot portal. This endpoint provides insights into the account type, time zone, currency settings, and data hosting location. It is useful for obtaining a comprehensive overview of the account's configuration and settings. - [Retrieve private app daily API usage](https://developers.hubspot.com/docs/api-reference/latest/account/account-information/get-usage-details.md): Retrieve the daily API usage for private apps in the account. This endpoint provides insights into the API consumption patterns, helping users monitor and manage their API usage effectively. #### Audit Logs - [Account activity API](https://developers.hubspot.com/docs/api-reference/latest/account/audit-logs/guide.md): Learn more about the account activity API endpoints. - [Retrieve audit logs](https://developers.hubspot.com/docs/api-reference/latest/account/audit-logs/get-audit-logs.md): Retrieve activity history for user actions related to approvals, content updates, CRM object updates, security activity, and more (Enterprise only). Learn more about [activities included in audit log exports](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history-i… - [Retrieve login activity](https://developers.hubspot.com/docs/api-reference/latest/account/audit-logs/get-login.md): Retrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history). - [Retrieve security history](https://developers.hubspot.com/docs/api-reference/latest/account/audit-logs/get-security.md): Retrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history). #### Brands - [Brands API](https://developers.hubspot.com/docs/api-reference/latest/account/brands/guide.md): HubSpot's brands API endpoint provides information about brands tied to a user. - [Get business units for a user](https://developers.hubspot.com/docs/api-reference/latest/account/brands/get-brands.md): Retrieve the brands that a specific user can access. #### IP ranges - [HubSpot IP ranges](https://developers.hubspot.com/docs/api-reference/latest/account/ip-ranges/guide.md): Learn how to retrieve HubSpot's active IP addresses. - [Retrieve IP ranges](https://developers.hubspot.com/docs/api-reference/latest/account/ip-ranges/get-origins.md): Retrieve the list of IP ranges associated with different services and directions. This endpoint can be used to obtain IP range information for specific services such as EMAIL, API, DNS, WEB_SCRAPING, and TEST_SERVICE. The results can be filtered by the direction of network traffic, either INGRESS or… - [Retrieve simplified IP ranges](https://developers.hubspot.com/docs/api-reference/latest/account/ip-ranges/get-simple.md): Retrieve a simplified list of IP ranges associated with specific network origins in the HubSpot system. This endpoint allows filtering by direction and service type, making it useful for understanding network configurations and managing access controls. #### Settings ##### Consent banner - [Consent banner API](https://developers.hubspot.com/docs/api-reference/latest/account/settings/consent-banner/consent-banner-api.md): The consent banner enables you to enable/disable different analytics scripts based on user preferences. - [Implement Google Consent Mode](https://developers.hubspot.com/docs/api-reference/latest/account/settings/consent-banner/google-consent-mode.md): Google consent mode v2 is a framework designed to integrate website visitor consent preferences with Google's advertising and analytics tools. Learn how to implement Google consent mode manually. ##### Multicurrency - [Settings API | Currencies](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/guide.md): Learn more about the currencies API endpoints to view and update your account's currencies and exchange rates. - [Get the company currency](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/get-company-currency.md): Get the details for the company currency. The company currency is used in deal totals, reports, and the default currency for new deals. - [Get all currency codes](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/get-currency-codes.md): Retrieve a list of all available currency codes and their names. - [Set or update the company currency.](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/update-company-currency.md): Set or update the primary company currency. ###### Batch - [Create multiple exchange rates](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/batch/create-exchange-rates.md): Create multiple exchange rates in a single request. - [Retrieve multiple rates](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/batch/get-exchange-rates.md): Retrieve the details of multiple exchange rates in a single request, specified by their IDs. - [Update multiple exchange rates](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/batch/update-exchange-rates.md): Update the conversion rates for multiple exchange rates in a batch operation. ###### Central FX Rates - [Add a new currency with central exchange rates.](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/central-fx-rates/create-multicurrency.md): Create a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here. - [Retrieve information about the central exchange rates feature.](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/central-fx-rates/get-exchange-rates.md): Retrieve details on whether the central exchange rates feature is enabled for the portal. - [Retrieve currencies not supported by central exchange rates.](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/central-fx-rates/get-unsupported-currencies.md): Retrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated. ###### Exchange rates - [Add a new exchange rate](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/exchange-rates/create-exchange-rate.md): Create a new exchange rate with specified conversion rate and currency codes. - [Change the visibility of a specific currency pairs](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/exchange-rates/create-update-visibility.md): Change the visibility setting for a currency pair. This will hide or display a currency pair for users in the HubSpot app. - [Get all current exchange rates](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/exchange-rates/get-current-exchange-rates.md): Retrieve all current exchange rates for all currency pairs. - [Get the details for a specific exchange rate](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/exchange-rates/get-exchange-rate.md): Retrieve the details for a specific exchange rate specified by its ID. - [Get exchange rates](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/exchange-rates/get-exchange-rates.md): Get a list of exchange rates - [Update a conversion rate](https://developers.hubspot.com/docs/api-reference/latest/account/settings/multicurrency/exchange-rates/update-exchange-rate.md): Update an existing conversion rate, specified by its ID. ##### Tax Rates - [Get a specific tax rate](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tax-rates/get-tax-rate.md): Retrieve a specific tax rate by its `taxRateGroupId`. - [Get all tax rates](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tax-rates/get-tax-rates.md): Retrieve a paginated list of all tax rates set up in the account tax rate library ##### Teams - [Settings API | Teams](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/guide.md): Create and manage teams in your HubSpot account. - [Add Team Members](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/add-team-members.md): Assign new members to a specific team in your HubSpot account. This endpoint allows you to add users to a team by specifying their user IDs and roles. It is useful for managing team compositions and ensuring the right users have access to team resources. - [Create Team](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/create-team.md): Create a new team in your HubSpot account. This endpoint allows you to define the team's name, parent team, and members. The request body must include the team's name and members. Upon successful creation, the response will include the URL of the newly created team resource. - [List members](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/get-team-members.md): Retrieve a list of members for a specified team in your HubSpot account. This endpoint allows you to paginate through the team members using the 'limit' and 'after' query parameters. It is useful for managing and viewing team compositions and roles within your organization. - [Retrieve team](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/get-team.md): Retrieve detailed information about a specific team in your HubSpot account using the team's unique identifier. This endpoint is useful for accessing the team's properties, such as its name and parent team ID, to manage or display team-related data. - [List teams](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/get-teams.md): Retrieve a list of teams from your HubSpot account. This endpoint allows you to paginate through the teams using the 'limit' and 'after' query parameters. It is useful for obtaining an overview of all teams configured in the account. - [Delete member](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/remove-team-member.md): Remove a specific member from a team in your HubSpot account. This operation requires specifying both the team and user identifiers. It is useful for managing team compositions by removing users who no longer need access or association with a particular team. - [Update team](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/update-team.md): Update the details of a specific team in your HubSpot account. This endpoint allows you to modify the team's information, such as its name or parent team ID. Ensure that the teamId provided in the path is correct, as it identifies the team to be updated. - [Delete team](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/delete-team.md): Delete a specific team from your HubSpot account using the team's unique identifier. This operation will remove the team and its associated data. Ensure that you have the necessary permissions to perform this action. ###### Batch - [Batch assign members](https://developers.hubspot.com/docs/api-reference/latest/account/settings/teams/batch/add-team-members.md): Assign multiple members to a specific team in a single request. This endpoint allows for efficient management of team memberships by processing multiple assignments at once. It is useful for organizations looking to streamline their team management processes. ##### Tracking Code - [HubSpot tracking code API](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/overview.md): The HubSpot tracking code allows you to identify visitors, track events, and track page views. - [Add privacy consent listener](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/add-privacy-consent-listener.md): Check the consent status of a visitor when using the HubSpot consent banner. - [Enable do not track](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/do-not-track.md): Prevent tracking by placing a cookie in the visitor's browser. - [Identify a visitor](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/identify.md): Identify a visitor by email address to link their session to a HubSpot contact record. - [Revoke cookie consent](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/revoke-cookie-consent.md): Remove consent banner cookies for a visitor, such as for GDPR deletion requests. - [Set the current page path](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/set-path.md): Set the current page path for tracking in single-page applications. - [Track custom events](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/track-event.md): Track custom events in your HubSpot account and tie them to contact records. - [Track a page view](https://developers.hubspot.com/docs/api-reference/latest/account/settings/tracking-code/track-page-view.md): Manually track a page view, useful for single-page applications. ##### User Provisioning - [Settings API | User provisioning](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/guide.md): Create and manage users in your HubSpot account programmatically. - [Create a user](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/create-user.md): Create a new user in your HubSpot account using the specified details. This endpoint requires a JSON request body with user information such as email, first name, last name, role, and seats. A welcome email can be optionally sent to the new user. - [Retrieves users](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/get-users.md): Retrieve a paginated list of users in your HubSpot account. This endpoint allows you to specify the maximum number of results per page and to use a paging cursor for navigating through the list of users. ###### Roles - [Retrieves the roles on an account](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/roles/get-roles.md): Retrieve a list of user roles available in your HubSpot account. This endpoint provides information about the different permission sets that can be assigned to users, which is useful for managing user access and permissions within the account. ###### Seats - [Retrieves the seats on this account](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/seats/get-seats.md): Retrieve the list of seats available in the account. This endpoint provides details about each seat, including its name, description, and the number of remaining seats. It is useful for managing and reviewing seat allocations within your organization. ###### Teams - [See details about this account's teams](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/teams/get-teams.md): View teams for this account ###### Users - [Retrieves a user](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/users/get-user.md): Retrieves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param. - [Modifies a user](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/users/update-user.md): Modifies a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param. - [Removes a user](https://developers.hubspot.com/docs/api-reference/latest/account/settings/user-provisioning/users/delete-user.md): Removes a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param. ### App Management #### App Uninstalls - [App uninstalls API](https://developers.hubspot.com/docs/api-reference/latest/app-management/app-uninstalls/guide.md): Learn how to use the app uninstalls API to programmatically uninstall an app from a HubSpot account. - [Uninstall app](https://developers.hubspot.com/docs/api-reference/latest/app-management/app-uninstalls/uninstall-app.md): Use this endpoint to uninstall your app from a customer's HubSpot account. If successful, this endpoint will return a 204 and the customer will receive an email notification that the developer has uninstall the app from their account. #### Feature Flags - [Feature flags](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/guide.md): Learn how to use the feature flags API to control access to supported app features for installed customer accounts. ##### Flags - [Retrieve a feature flag](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/flags/get-feature-flag.md): Retrieve the current status of the app's feature flags. No request body is included. - [Retrieve an app's feature flags](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/flags/get-feature-flags.md): Retrieve all feature flags associated with a specific application in your HubSpot account. This endpoint is useful for developers who need to manage or audit feature flags for their applications. It requires the application ID to identify which application's flags to list. - [Set an app's feature flag](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/flags/update-feature-flag.md): Set a feature flag for an app. For example, update the `hs-hide-crm-cards` flag's `defaultState` to `ON` to hide classic CRM cards from new installs. - [Delete an app's feature flag](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/flags/delete-feature-flag.md): Delete a feature flag in an app. For example, delete the `hs-release-app-cards` flag after all accounts have been migrated. ##### Portal Flag States - [Retrieve account flag state](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/portal-flag-states/get-account-flag.md): Retrieve the account-level flag state of a specific HubSpot account. - [Retrieve accounts with a set flag state](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/portal-flag-states/get-accounts-with-flag-state.md): Retrieve a list of HubSpot accounts with an account-level flag setting for the specified app. No request body is included. - [Set an account flag state](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/portal-flag-states/update-account-flag.md): Specify an account-level flag state for a specific HubSpot account. - [Batch set account flag state](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/portal-flag-states/upsert-account-flag.md): Set the portal flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts. - [Batch delete account flag state](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/portal-flag-states/delete-portal-flag-batch.md): Delete an account-level flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts. - [Delete an account flag state](https://developers.hubspot.com/docs/api-reference/latest/app-management/feature-flags/portal-flag-states/delete-portal-flag.md): Delete an account-level flag state for a specific HubSpot account. No request body is included. ### Authentication - [Manage OAuth access tokens with the 2026-09 API](https://developers.hubspot.com/docs/api-reference/latest/authentication/manage-oauth-tokens.md): Learn how to use the 2026-09 OAuth endpoints to manage access and refresh tokens to securely perform CRUD actions with HubSpot APIs. #### OAuth tokens - [Refresh an access token](https://developers.hubspot.com/docs/api-reference/latest/authentication/oauth-tokens/refresh-oauth-token.md): Authenticates a client and returns access and refresh tokens. - [Revoke an OAuth token](https://developers.hubspot.com/docs/api-reference/latest/authentication/oauth-tokens/revoke-token.md): Deletes/Revokes provided Refresh Token - [Token introspection endpoint](https://developers.hubspot.com/docs/api-reference/latest/authentication/oauth-tokens/token-introspect.md): Returns validity and metadata for access and refresh tokens. ### Automation #### Email templates - [Email templates](https://developers.hubspot.com/docs/api-reference/latest/automation/email-templates/guide.md): Create and manage sales email templates in HubSpot. - [Create template](https://developers.hubspot.com/docs/api-reference/latest/automation/email-templates/create-email-template.md): Create a new email template in your HubSpot account. This endpoint allows you to define the template's name, subject, body, and optionally assign it to a folder. The request must include the template's body and name. Please note: the scopes for these endpoints require user-level access and will not… - [Retrieve template](https://developers.hubspot.com/docs/api-reference/latest/automation/email-templates/retrieve-email-template.md): Retrieve a specific email template by its unique identifier. This endpoint allows you to access the details of an email template, which can be useful for reviewing or managing your email automation strategies. Please note: the scopes for these endpoints require user-level access and will not work fo… - [Retrieve templates](https://developers.hubspot.com/docs/api-reference/latest/automation/email-templates/retrieve-email-templates.md): Retrieve a list of email templates available in the HubSpot account. This endpoint supports pagination to navigate through large sets of templates. Use this endpoint to access and manage your email templates efficiently. Please note: the scopes for these endpoints require user-level access and will… - [Retrieve folders](https://developers.hubspot.com/docs/api-reference/latest/automation/email-templates/retrieve-folders.md): Retrieve a list of email template folders available in your HubSpot account. This endpoint supports pagination to navigate through large sets of folders. Use this endpoint to organize and manage your email templates efficiently. Please note: the scopes for these endpoints require user-level access a… - [Update template](https://developers.hubspot.com/docs/api-reference/latest/automation/email-templates/update-email-template.md): Update an existing email template in your HubSpot account. This endpoint allows you to modify the template's properties such as name, subject, body, and folderId. Ensure that the templateId provided corresponds to an existing template. Please note: the scopes for these endpoints require user-level a… #### Sequences - [Sequences API](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/guide.md): Learn how to use the sequences API to create and manage sequences and contact sequence enrollments. - [Create sequence](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/create-sequence.md): Create a new sequence in your HubSpot account using the specified settings and steps. This endpoint allows you to define the sequence's properties, such as its name, settings, steps, and dependencies, to automate processes effectively. Please note: the scopes for this endpoint requires user-level ac… - [List sequences](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/list-sequences.md): Retrieve a list of sequences available in the service account. This endpoint supports pagination and allows filtering by sequence name. It is useful for obtaining an overview of sequences for management or reporting purposes. Please note: the scopes for this endpoint requires user-level access and w… - [Retrieve performance](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/retrieve-performance.md): Retrieve the performance metrics of a specific sequence in your HubSpot account. This endpoint provides detailed insights into the sequence's effectiveness, including metrics such as opened, clicked, and replied rates. It is useful for analyzing the success of your sequences over time. Please note:… - [Retrieve sequence](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/retrieve-sequence.md): Retrieve details of a specific sequence in your HubSpot account using the sequence ID. This endpoint provides comprehensive information about the sequence, including its settings, steps, and dependencies. It is useful for obtaining sequence configurations and understanding the sequence's structure a… - [Update sequence](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/update-sequence.md): Update an existing sequence in your HubSpot account using its unique identifier. This endpoint allows you to modify the sequence settings, steps, and dependencies. Ensure that the sequenceId provided in the path is valid and corresponds to the sequence you wish to update. Please note: the scopes for… - [Delete sequence](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/delete-sequence.md): Delete a specific sequence in your HubSpot account using its unique identifier. This operation will remove the sequence and can optionally override active enrollments if specified. Please note: the scopes for this endpoint requires user-level access and will not work for existing apps with portal-le… ##### Enrollments - [Enroll a contact](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/enrollment/enroll-a-contact.md): Enroll a contact into a sequence using the specified sequence ID. This operation requires the user ID to be provided as a query parameter. The request body must include the contact ID, sender email, and sequence ID. This endpoint is useful for automating the enrollment of contacts into predefined se… - [Enroll service account](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/enrollment/enroll-service-account.md): Enroll a service account into a sequence using the specified enrollment details. This endpoint is useful for automating the process of adding service accounts to sequences, which can help streamline workflows and ensure consistent engagement strategies. Please note: the scopes for this endpoint requ… - [Retrieve enrollment details](https://developers.hubspot.com/docs/api-reference/latest/automation/sequences/enrollment/retrieve-enrollment-details.md): Retrieve the sequence enrollment details for a specific contact in your HubSpot account. This endpoint provides information about the sequence a contact is enrolled in, including enrollment dates and the sequence's name and ID. #### Workflow actions - [Build custom workflow actions](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/custom-action-guide.md): An introduction and overview of workflow extensions. - [Custom workflow actions reference](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/custom-action-reference.md): Reference information for creating custom workflow actions. - [Custom code actions](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/custom-code-actions.md): Instructions for using custom code actions in workflows ##### Callbacks - [Complete a batch of callbacks](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/callbacks/batch-complete-callbacks.md): Complete a batch of blocked action executions. - [Complete a callback](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/callbacks/complete-callback.md): Complete a specific blocked action execution by ID. ##### Definitions - [Create a new custom action definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/definitions/create-action-definition.md): Create a new custom workflow action. - [Retrieve a custom action definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/definitions/get-action-definition.md): Retrieve a custom workflow action definition by ID. - [Retrieve custom action definitions](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/definitions/get-action-definitions.md): Retrieve custom workflow action definitions by app ID. - [Set the object requirement for a custom action definition.](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/definitions/set-object-requirement.md): Set whether a custom action definition requires an object. - [Update an existing action definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/definitions/update-action-definition.md): Update an existing action definition by ID. - [Delete an action definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/definitions/delete-action-definition.md): Delete an action definition by ID. ##### Functions - [Insert a function for a definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/functions/add-function.md): Add a function for a given definition. - [Archive a function for a definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/functions/archive-function.md): Archive a function for a specific definition. - [Retrieve a function from a given definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/functions/get-function.md): Retrieve a specific function from a given definition. - [Retrieve functions by a type for a given definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/functions/get-functions-by-type.md): Retrieve functions of a specific type for a given definition. - [Retrieve functions for a given definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/functions/get-functions.md): Retrieve all functions included in a definition. - [Update a function for a definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/functions/update-function.md): Update a function for a given definition by ID. - [Delete a function for a definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/functions/delete-function.md): Delete a function within a given definition. ##### Revisions - [Retrieve a specific revision of a definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/revisions/get-revision.md): Retrieve a specific revision of a definition by revision ID. - [Retrieve revisions for a given definition](https://developers.hubspot.com/docs/api-reference/latest/automation/workflow-actions/revisions/get-revisions.md): Retrieve the versions of a definition by ID. ### Communication preferences - [Communication preferences API guide](https://developers.hubspot.com/docs/api-reference/latest/communication-preferences/guide.md): The subscription preferences endpoints allow you to manage email subscription details for contacts in your account. #### Definitions - [Retrieve all subscription status definitions](https://developers.hubspot.com/docs/api-reference/latest/communication-preferences/definitions/get-subscription-definitions.md): Get a list of subscription status definitions from the account. #### Status - [Get subscription preferences for a specific contact](https://developers.hubspot.com/docs/api-reference/latest/communication-preferences/status/get-subscription.md): Retrieve a contact's current email subscription preferences. - [Retrieve a contact's unsubscribed status](https://developers.hubspot.com/docs/api-reference/latest/communication-preferences/status/get-unsubscribed-status.md): Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty. - [Update a contact's subscription status](https://developers.hubspot.com/docs/api-reference/latest/communication-preferences/status/update-subscription.md): Set the subscription status of a specific contact. ##### Batch - [Batch retrieve subscription statuses](https://developers.hubspot.com/docs/api-reference/latest/communication-preferences/status/batch/get-subscriptions.md): Batch retrieve subscription statuses for a set of contacts. - [Batch unsubscribe contacts from all subscriptions](https://developers.hubspot.com/docs/api-reference/latest/communication-preferences/status/batch/unsubscribe-contacts-batch.md): Unsubscribe a set of contacts from all email subscriptions. ### Conversations - [Conversations](https://developers.hubspot.com/docs/api-reference/latest/conversations/guide.md): Integrate with HubSpot's conversations inbox using client SDKs or REST APIs. #### Chat Configuration - [Conversations SDK](https://developers.hubspot.com/docs/api-reference/latest/conversations/chat-configuration/chat-widget-sdk.md): HubSpot's Live Chat widget allows you to chat with customers on your website. With the Chat Widget SDK, you can customize the behavior of the chat widget. - [Running code snippets in bots](https://developers.hubspot.com/docs/api-reference/latest/conversations/chat-configuration/working-with-chatbots.md): Learn how to configure code snippets in a bot action for a chatflow. ##### Mobile chat SDK - [Integrate the HubSpot mobile chat SDK into your Android app](https://developers.hubspot.com/docs/api-reference/latest/conversations/chat-configuration/mobile-chat-sdk/android.md): Use the HubSpot mobile chat SDK to integrate your Android mobile application with HubSpot's live chat functionality. - [Integrate the HubSpot mobile chat SDK into your iOS app](https://developers.hubspot.com/docs/api-reference/latest/conversations/chat-configuration/mobile-chat-sdk/ios.md): Use the HubSpot mobile chat SDK to integrate your iOS mobile application with HubSpot's live chat functionality. #### Conversations - [Conversations API](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/guide.md): Use the conversations API to manage inboxes, channels, threads, and messages. ##### Actors - [Retrieve actor](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/actors/get-actor.md): Retrieve information about a specific actor in the conversations system using their unique actor ID. This endpoint is useful for obtaining details about a particular actor, which could be an agent, bot, or other entity involved in conversations. - [Batch retrieve actors](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/actors/get-actors.md): Retrieve information about multiple actors in a batch operation. This endpoint is useful for obtaining details on various actors in a single request, streamlining data retrieval processes. ##### Channel accounts - [Retrieve channel account](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/channel-accounts/get-channel-account.md): Retrieve details of a specific channel account in your HubSpot account using the unique channelAccountId. This endpoint is useful for accessing information about a particular channel account, including its archived status. - [List channel accounts](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/channel-accounts/get-channel-accounts.md): Retrieve a list of channel accounts associated with your HubSpot account. This endpoint allows you to filter results by channel ID, inbox ID, and other criteria. It's useful for managing and reviewing the channel accounts linked to your conversations. ##### Channels - [Retrieve channel](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/channels/get-channel.md): Retrieve details of a specific channel in your HubSpot account using the channel's unique identifier. This endpoint is useful for accessing channel-specific information, which can be used for managing or analyzing communication channels. - [List Channels](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/channels/get-channels.md): Retrieve a list of channels in your HubSpot account. This endpoint supports pagination and sorting, allowing you to manage large sets of data effectively. Use this endpoint to get an overview of all available channels. ##### Inbox - [Retrieve inbox](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/inbox/get-inbox.md): Retrieve details of a specific inbox within your HubSpot account using its unique identifier. This endpoint allows you to access information about the inbox, including whether it is archived. It is useful for managing and organizing conversations within different inboxes. - [List inboxes](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/inbox/get-inboxes.md): Retrieve a list of inboxes in your HubSpot account. This endpoint allows you to paginate through results and sort them as needed. It can also filter to include only archived inboxes. ##### Messages - [Create message](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/messages/create-message.md): Create a new message within a specific thread in your HubSpot account. This endpoint allows you to add messages to existing conversation threads, which can be useful for continuing discussions or providing additional information. Ensure that the threadId is correctly specified to target the appropri… - [Retrieve message content](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/messages/get-message-content.md): Retrieve the original content of a specific message within a thread. This endpoint is useful for accessing the unaltered text or rich text content of a message, which can be important for auditing or reviewing the initial communication in a conversation. - [Retrieve message](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/messages/get-message.md): Retrieve a specific message from a conversation thread in your HubSpot account. This endpoint allows you to access the details of a message identified by its messageId within a thread identified by threadId. You can specify certain properties to include in the response. - [Retrieve messages](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/messages/get-messages.md): Retrieve messages from a specific conversation thread in your HubSpot account. This endpoint allows you to access all messages associated with a given thread, which can be useful for reviewing conversation history or analyzing communication patterns. ##### Threads - [Retrieve thread](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/threads/get-thread.md): Retrieve details of a specific conversation thread using its unique identifier. This endpoint allows you to access information about the thread, including its properties and associations. It is useful for fetching thread details for further processing or display. - [Retrieve threads](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/threads/get-threads.md): Retrieve a list of conversation threads from the specified inboxes. This endpoint allows filtering by associated contact or ticket, thread status, and other parameters. It supports pagination and sorting to help manage large sets of data effectively. - [Update assignee](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/threads/update-assignee.md): Assign a specific actor to a conversation thread in your HubSpot account. This endpoint allows you to update the assignee for a given thread, which can be useful for managing workload distribution among team members. - [Update thread](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/threads/update-thread.md): Update the details of a specific conversation thread in your HubSpot account. This endpoint allows you to modify the status or other attributes of the thread identified by the threadId. It is useful for managing the state of conversation threads, such as marking them as open or closed. - [Delete Assignee](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/threads/delete-assignee.md): Remove the assignee from a specific conversation thread in your HubSpot account. This operation is useful when you want to unassign a thread from a user, making it available for reassignment or indicating that it no longer requires a specific assignee. - [Delete thread](https://developers.hubspot.com/docs/api-reference/latest/conversations/conversations/threads/delete-thread.md): Delete a specific conversation thread in your HubSpot account. This operation removes the thread identified by the threadId from the system. Use this endpoint to manage and clean up conversation threads that are no longer needed. #### Custom Channels - [Custom channels API guide](https://developers.hubspot.com/docs/api-reference/latest/conversations/custom-channels/guide.md): Learn how to use the latest custom channel API for the conversations inbox and help desk. ##### Messages - [Publish a message](https://developers.hubspot.com/docs/api-reference/latest/conversations/custom-channels/messages/create-custom-channel.md): Publish a message over your custom channel - [Get a message](https://developers.hubspot.com/docs/api-reference/latest/conversations/custom-channels/messages/get-custom-channel.md): Get the details for a specific message sent over a custom channel - [Update a message](https://developers.hubspot.com/docs/api-reference/latest/conversations/custom-channels/messages/update-custom-channel.md): Update a message's status to indicate if it was successfully sent, failed to send, or was read. For failed messages, this can also include the error message for the failure. #### Visitor identification - [Generate visitor token](https://developers.hubspot.com/docs/api-reference/latest/conversations/visitor-identification/create-visitor-identification.md): Generate an identification token for a website visitor who has been authenticated using your own system. An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. This… ### Data studio #### Datasource ingestion - [Data source ingestion API](https://developers.hubspot.com/docs/api-reference/latest/data-studio/datasource-ingestion/guide.md): Upload JSON data or other local files directly into HubSpot Data Studio as independent datasets. - [Create data source](https://developers.hubspot.com/docs/api-reference/latest/data-studio/datasource-ingestion/create-datasource.md): Uploads a file (csv, tsv, json, or xlsx) along with a column schema to create a new datasource. Uses multipart/form-data with a request JSON part (containing datasourceName, datasourceType: FILE, and config.file with column definitions) and a file binary part. - [Retrieve data source](https://developers.hubspot.com/docs/api-reference/latest/data-studio/datasource-ingestion/get-datasource.md): Retrieve detailed information about a specific data source in HubSpot Data Studio. This endpoint provides details such as the data source's name, type, creation date, and the status of the last data ingestion. It is useful for developers who need to access and manage data sources programmatically. - [Update data source](https://developers.hubspot.com/docs/api-reference/latest/data-studio/datasource-ingestion/update-datasource.md): Update an existing data source in HubSpot Data Studio. This endpoint allows you to modify the details of a specific data source identified by its datasourceId. The request must include a multipart form-data body with the necessary fields to update the data source - [Delete data source](https://developers.hubspot.com/docs/api-reference/latest/data-studio/datasource-ingestion/delete-datasource.md): Delete a data source in HubSpot Data Studio. This operation is used to remove a specific data source identified by its ID. Ensure that the data source is no longer needed before deletion, as this action cannot be undone. ### Events - [Events API](https://developers.hubspot.com/docs/api-reference/latest/events/guide.md): Event endpoints help you find and filter events and event occurrences linked to CRM records. #### Define events - [Define custom events](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/guide.md): Learn more about creating custom events using HubSpot's API. - [Create an event definition](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/create-event-definition.md): Create a new behavioral event definition in your HubSpot account. This endpoint allows you to define the structure and properties of a new behavioral event, which can then be used to track specific user actions or behaviors. The request body must include the necessary event details and property defi… - [Create an event property](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/create-event-property.md): Create a new property for a specified event definition in your HubSpot account. This endpoint allows you to define custom properties associated with a particular event, enhancing the tracking and analysis of behavioral events. The request must include a JSON body with the necessary property details. - [Get an event definition](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/get-event-definition.md): Retrieve the definition of a specific behavioral event in your HubSpot account by providing the event name. This endpoint returns detailed information about the event type, including its properties and associations. - [Get all event definitions](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/get-event-definitions.md): Retrieve a list of event definitions available in your HubSpot account. This endpoint allows you to search and filter event definitions based on various criteria, such as search strings and pagination options. It is useful for managing and understanding the different event types that are tracked wit… - [Update an event definition](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/update-event-definition.md): Update the definition of a specific behavioral event in your HubSpot account. This operation allows you to modify the properties and templates associated with the event. The eventName path parameter identifies the event to be updated. - [Update an event property](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/update-event-property.md): Update a specific property of a behavioral event definition in your HubSpot account. This operation allows you to modify the details of an existing property associated with a given event. Use this endpoint to keep your event properties up-to-date with the latest information. - [Delete an event definition](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/delete-event-definition.md): Delete a specific event definition in your HubSpot account using the event's unique name. This operation is useful for removing outdated or incorrect event definitions that are no longer needed. - [Delete an event property](https://developers.hubspot.com/docs/api-reference/latest/events/define-events/delete-event-property.md): Delete a specific property from an event definition in your HubSpot account. This operation is useful when you need to remove obsolete or incorrect properties from an event definition. Ensure that the event and property names are accurately specified to avoid unintended deletions. #### Retrieve events - [Retrieve event types](https://developers.hubspot.com/docs/api-reference/latest/events/retrieve-events/get-event-types.md): Retrieve a list of event type names. You may use these event types to query the API for event occurrences of a desired type. - [Retrieve event occurrences](https://developers.hubspot.com/docs/api-reference/latest/events/retrieve-events/get-events.md): Retrieve event occurrences for a specified date in September 2026. This endpoint allows you to filter and sort events based on various criteria, such as event type, object type, and occurrence dates. It supports pagination and can return specific properties of events if requested. #### Send event data - [Send custom event occurrences](https://developers.hubspot.com/docs/api-reference/latest/events/send-event-data/guide.md): Custom events allow you to track advanced activity via a JavaScript or HTTP API. The Events API can be used to get details about your events. - [Send a batch of event occurrences](https://developers.hubspot.com/docs/api-reference/latest/events/send-event-data/batch-send-occurrences.md): Send multiple event occurrences at once. - [Send an event occurrence](https://developers.hubspot.com/docs/api-reference/latest/events/send-event-data/send-event-occurrence.md): Send data for a single custom event occurrence. ### Files - [Files API](https://developers.hubspot.com/docs/api-reference/latest/files/guide.md): Learn how to upload and manage files in your HubSpot account using the files API. #### Files - [Check import status](https://developers.hubspot.com/docs/api-reference/latest/files/files/get-file-status.md): Retrieve the status of an asynchronous file import task using the task ID. This endpoint provides information about the current state of the task, such as whether it is pending, processing, canceled, or complete. - [Import file from URL](https://developers.hubspot.com/docs/api-reference/latest/files/files/import-from-url.md): Import a file asynchronously from a specified URL into the HubSpot file manager. This endpoint allows you to specify various parameters such as access level, duplicate validation strategy, and whether to overwrite existing files. The operation is processed asynchronously, and a task locator is retur… - [Search files](https://developers.hubspot.com/docs/api-reference/latest/files/files/search-files.md): Search for files in the HubSpot account using various filters and criteria. This endpoint allows you to specify multiple query parameters to narrow down the search results based on properties like creation date, size, type, and more. It supports pagination and sorting to manage large sets of data ef… #### Folders - [Check folder update status](https://developers.hubspot.com/docs/api-reference/latest/files/folders/get-folder-update-status.md) - [Search folders](https://developers.hubspot.com/docs/api-reference/latest/files/folders/search-folders.md): Search for folders in the HubSpot file manager using various query parameters to filter results. This endpoint allows you to retrieve folders based on specific criteria such as creation date, update date, folder name, and parent folder IDs. It supports pagination and sorting to help manage large set… - [Update folder properties by folder ID](https://developers.hubspot.com/docs/api-reference/latest/files/folders/update-folder-folderId.md): Update the details of a specific folder in the file manager by providing the folder's unique identifier. This operation allows you to modify folder attributes such as its name or parent folder ID. ### Meetings #### Notetaker - [Notetaker conversations recap API](https://developers.hubspot.com/docs/api-reference/latest/meetings/notetaker/guide.md): Programmatically read AI-generated summaries and action items from calls and meeting events recorded by HubSpot's AI Notetaker. - [Retrieve conversation recap data](https://developers.hubspot.com/docs/api-reference/latest/meetings/notetaker/get-conversation-recap.md): Retrieve a recap of a conversation based on the specified object type and object ID. This endpoint provides a variety of insights related to the conversation, including summary, action items, questions asked, call stats, participants, and recording URL. #### Scheduler - [Meetings scheduler API](https://developers.hubspot.com/docs/api-reference/latest/meetings/scheduler/guide.md): Use the meetings API to retrieve information about meetings created through a scheduling page, book a meeting, and manage payment link associations. ##### Calendar - [Create a new calendar event for a meeting](https://developers.hubspot.com/docs/api-reference/latest/meetings/scheduler/calendar/create-calendar-event.md): Create a new calendar meeting event in your HubSpot account. This endpoint allows you to specify details such as the meeting title, start and end times, and associated users. The organizerUserId is required to identify the meeting organizer. ##### Meetings - [Book Meeting](https://developers.hubspot.com/docs/api-reference/latest/meetings/scheduler/meetings/create-meeting.md): Book a meeting using a specified meeting link. This endpoint allows you to create a meeting by providing necessary details such as duration, email, and start time. It is useful for scheduling meetings programmatically through HubSpot's API. - [Retrieve meeting links](https://developers.hubspot.com/docs/api-reference/latest/meetings/scheduler/meetings/get-meeting-links.md): Retrieve a list of meeting links available in the HubSpot account. This endpoint allows filtering by various criteria such as meeting name, organizer user ID, and meeting type. It supports pagination to navigate through large sets of results. - [Retrieve booking info](https://developers.hubspot.com/docs/api-reference/latest/meetings/scheduler/meetings/get-meeting-slug.md): Retrieve detailed booking information for a specific meeting link using its slug. This endpoint provides insights into the availability and settings associated with the meeting link. It is useful for understanding the booking context and ensuring that the correct timezone is applied. - [Retrieve availability](https://developers.hubspot.com/docs/api-reference/latest/meetings/scheduler/meetings/get-availability.md): Retrieve the availability and busy times for a specific meeting link. This endpoint is useful for checking available slots for booking meetings based on the provided slug. It requires specifying the timezone and optionally allows adjusting the month view with an offset. ### Revenue #### Payment Accounts - [Payments accounts API](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-accounts/guide.md): Retrieve the status of the payments account connected to your HubSpot account. - [Retrieve payment accounts status](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-accounts/get-payment-account.md): Retrieve the status of payment accounts in your HubSpot account. This endpoint provides information about the account's ability to transact and payout, its enrollment state, when or if it has transacted last, and the types of payment processors it is eligible for. Use this to monitor and manage your… #### Payment Links - [Payment links API](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-links/guide.md): Create and manage payment links programmatically. - [Create a payment link](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-links/create-payment-link.md): Create a new payment link in your HubSpot account. This endpoint allows you to specify various attributes for the payment link, such as accepted payment methods, currency, and additional form fields. The payment link can be configured for one-time use and can also collect shipping and billing addres… - [Retrieve a payment link](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-links/get-payment-link.md): Retrieve details of a specific payment link using its unique identifier. This endpoint allows you to access information about the payment link, including its status and configuration. It is useful for checking the current settings or status of a payment link in your HubSpot account. - [Retrieve payment links](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-links/get-payment-links.md): Retrieve a list of payment links from your HubSpot account. This endpoint allows you to filter and sort payment links based on various criteria such as creation and update timestamps. It supports pagination and can include archived payment links if specified. - [Update a payment link](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-links/update-payment-link.md): Update a payment link by ID. - [Delete a payment link](https://developers.hubspot.com/docs/api-reference/latest/revenue/payment-links/delete-payment-link.md): Delete a specific payment link in your HubSpot account. This operation is irreversible and will remove the payment link identified by the provided ID. Use this endpoint to manage and clean up payment links that are no longer needed. #### Price Books - [Price books API](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/guide.md): Create and manage price books and product pricing programmatically. - [Activate a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/activate-price-book.md): Activate a specific price book in your HubSpot account. This operation changes the status of the price book to active, allowing it to be used in transactions and other operations. Ensure that the price book ID is correct before activation. - [Create a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/create-price-book.md): Create a new price book in your HubSpot account. This endpoint allows you to define custom properties, a name, and supported currencies for the price book. A successful request will return the URL of the newly created resource. - [Deactivate a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/deactivate-price-book.md): Deactivate a specific price book in your HubSpot account. This action changes the status of the price book to inactive, making it unavailable for use in transactions. Use this endpoint when you need to temporarily or permanently disable a price book without deleting it. - [Retrieve a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/get-price-book.md): Retrieve a specific price book by its unique identifier in your HubSpot account. This endpoint allows you to access detailed information about a price book, including its status and supported currencies. It can be useful for managing and reviewing pricing strategies within your commerce system. - [Retrieve price books](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/get-price-books.md): Retrieve a list of price books available in your HubSpot account. This endpoint supports pagination and can return archived price books if specified. It is useful for accessing and managing pricing information across different products and services. - [Update a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/update-price-book.md): Update an existing price book in your HubSpot account. This operation allows you to modify details such as the name, description, supported currencies, and custom properties of a price book. It is useful for keeping your price book information up to date with the latest changes. - [Validate a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/validate-price-book.md): Validate a specific price book in your HubSpot account. This endpoint checks the integrity and correctness of the price book identified by the given priceBookId. Use this to ensure that the price book meets all necessary criteria before proceeding with further operations. - [Delete a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/delete-price-book.md): Delete a specific price book from your HubSpot account using its unique identifier. This operation will permanently remove the price book and its associated data, making it unavailable for future use. ##### Items - [Add a product to a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/add-product-to-price-book.md): Add new items to a specified price book in your HubSpot account. This endpoint allows you to associate products with a price book by providing the necessary product details. It is useful for managing and updating the contents of your price books efficiently. - [Retrieve a price book item](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/get-price-book-item.md): Retrieve a specific item from a price book using its unique identifiers. This endpoint allows you to access detailed information about a particular item within a specified price book, including its properties and archived status if applicable. - [Retrieve price book items](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/get-price-book-items.md): Retrieve a list of items associated with a specific price book in your HubSpot account. This endpoint allows you to paginate through the items and specify which properties to include in the response. It is useful for managing and viewing the details of products linked to a particular price book. - [Update a price book item](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/update-price-book-item.md): Update a specific item within a price book in your HubSpot account. This operation allows you to modify details such as pricing, billing frequency, and custom properties for the specified item. Ensure that the item is identified correctly by its unique priceBookId and priceBookItemId. - [Delete a price book item](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/delete-price-book-item.md): Remove a specific item from a price book in your HubSpot account. This operation is irreversible and will permanently delete the item identified by the given priceBookItemId from the price book specified by priceBookId. ###### Batch - [Archive price book items](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/batch/batch-archive-price-book-items.md): Archive multiple items within a specified price book in a single batch operation. This endpoint is useful for managing large sets of price book items that need to be archived simultaneously, streamlining the process and reducing the number of individual requests. - [Add products to a price book](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/batch/batch-create-price-book-items.md): Create multiple items in a specified price book in a single batch operation. This endpoint is useful for efficiently adding a large number of items to a price book, reducing the need for multiple individual requests. The operation returns a batch response indicating the success or failure of each it… - [Update price book items](https://developers.hubspot.com/docs/api-reference/latest/revenue/price-books/items/batch/batch-update-price-book-items.md): Update multiple items in a specified price book in a single batch operation. This endpoint allows for efficient updates of price book items, making it useful for managing large sets of data within a price book. The operation returns a batch response indicating the success or failure of each item upd… ### Webhooks - [Webhooks API guide](https://developers.hubspot.com/docs/api-reference/latest/webhooks/guide.md): Learn how to use the webhooks subscription management APIs. #### Subscriptions - [Create an event subscription](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/create-webhook-appId.md): Create new event subscription for the specified app. - [Read an event subscription](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/get-webhook-subscriptionId.md): Retrieve a specific event subscription by ID. - [Read webhook settings](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/get-webhooks-appId.md): Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date. - [Read event subscriptions](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/get-webhooks-subscriptions.md): Retrieve event subscriptions for the specified app. - [Update an event subscription](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/update-webhook-subscriptionId.md): Update an existing event subscription by ID. - [Update webhook settings](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/update-webhook.md): Update webhook settings for the specified app. - [Delete webhook settings](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/delete-webhook-appId.md): Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created. ##### Batch - [Batch create event subscriptions](https://developers.hubspot.com/docs/api-reference/latest/webhooks/subscriptions/batch/create-webhooks.md): Batch create event subscriptions for the specified app. ### Webhooks journal - [Webhooks journal and management APIs (2026-09)](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/guide.md): Learn how to get started with the latest webhook journal and management APIs (2026-09) #### Journal entries - [Webhook journal APIs](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/guide.md): Learn how to use the latest version of the webhook journal APIs (2026-09). ##### Aggregate journal - [Get the earliest journal entry](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/aggregate/get-journal-earliest.md): Retrieve the earliest entry from the webhooks journal for the specified portal. This endpoint is useful for accessing the first recorded webhook event in the journal, which can be helpful for auditing or debugging purposes. - [Get journal status](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/aggregate/get-journal-status.md): Retrieve the status of a specific webhook journal entry using its unique status ID. This endpoint provides detailed information about the status, including whether it is pending, in progress, completed, failed, or expired. It is useful for monitoring and managing the state of webhook journal entries… - [Read journal entries in batch](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/aggregate/get-read.md): Execute a batch read operation on the webhooks journal for the specified date, 2026-03. This endpoint allows you to retrieve multiple entries from the webhooks journal in a single request, which can be useful for processing large amounts of data efficiently. Ensure that the request body is provided… ##### Local journal - [Get the earliest local journal entry](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/local/get-journal-local-earliest.md): Retrieve the earliest webhook journal entries for the specified portal. This endpoint can be used to access the oldest records available in the webhook journal, which may be useful for auditing or historical analysis. - [Get the latest local journal entry](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/local/get-journal-local-latest.md): Retrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events that have been logged, allowing for real-time monitoring or debugging of webhook activities. - [Get the next local journal entry](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/local/get-journal-local-next.md): Retrieve the next set of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through large sets of webhook data, allowing you to continue from where a previous request left off. - [Get local journal status](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/local/get-journal-local-status.md): Retrieve the status of a specific webhook journal entry using its unique status ID. This endpoint is useful for monitoring the progress or outcome of webhook journal entries, allowing you to check if an entry is pending, in progress, completed, failed, or expired. ###### Batch - [Get the latest local journal entries in batch](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/local/batch/get-webhook-count.md): Retrieve the latest batch of webhook journal entries. This endpoint allows you to specify the number of entries to fetch, providing a way to access the most recent webhook events processed by your HubSpot account. - [Get the earliest local journal entries in batch](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/local/batch/get-webhook.md): Retrieve the earliest batch of webhook journal entries. This endpoint is useful for accessing the oldest available data in the webhook journal, allowing users to process or analyze historical webhook events. The number of entries to fetch is specified by the 'count' path parameter. - [Read local journal entries in batch](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/journal-entries/local/batch/get-webhooks.md): Execute a batch read operation on the webhooks journal. This endpoint allows you to retrieve a batch of webhook journal entries by providing the necessary input data. It is useful for processing multiple records in a single request, streamlining data retrieval tasks. #### Snapshots - [Webhook CRM snapshots API](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/snapshots/guide.md): Learn how to use the latest version of the webhook CRM snapshot APIs (2026-09). - [Create CRM object snapshots](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/snapshots/create-webhook.md): Create a batch of CRM object snapshots in HubSpot. This endpoint is used to capture the current state of specified CRM objects for later reference or analysis. It requires a JSON payload containing the details of the CRM objects to snapshot. This operation is exempt from daily and ten-secondly rate… #### Subscriptions - [Webhooks journal management APIs (2026.03)](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/guide.md): Learn how to use the latest version of the webhooks subscription management APIs (2026-09). - [Create a subscription filter](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/create-filters.md): Create a new filter for a specific webhook subscription in the HubSpot account. This endpoint allows you to define conditions that determine when a webhook should be triggered. The filter is associated with a subscription identified by its ID, and the request must include the filter details. - [Create or update a subscription](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/create-subscription.md): Create a new webhook journal subscription for the specified portal. This endpoint allows you to define the actions and object types that the subscription will monitor. It requires a request body with the subscription details. - [Get a subscription filter](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/get-filter.md): Retrieve a specific filter associated with a webhook journal subscription. This endpoint allows you to access the details of the filter identified by the filterId, which is useful for managing and understanding the conditions applied to webhook events. - [Get filters for a subscription](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/get-filters-by-subscription.md): Retrieve the filters associated with a specific webhook subscription. This endpoint allows you to view the filters applied to a subscription, which can help in managing and understanding the conditions set for webhook events. - [Get all subscriptions](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/get-subscriptions.md): Retrieve a list of webhook journal subscriptions. This endpoint provides access to subscription details without pagination, allowing you to view all current subscriptions in a single request. It is useful for managing and reviewing webhook subscriptions for your app. - [Update event subscriptions in batch](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/update-webhooks.md): Batch create event subscriptions for the specified app. - [Delete a subscription filter](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/delete-filter.md): Remove a specific filter from the webhooks journal subscriptions. This operation is useful for managing and cleaning up filters that are no longer needed. Once deleted, the filter cannot be recovered. - [Delete a subscription](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/delete-subscription.md): Delete a specific webhook journal subscription using its unique identifier. This operation is useful for managing and cleaning up subscriptions that are no longer needed in your HubSpot account. - [Delete all subscriptions for an account](https://developers.hubspot.com/docs/api-reference/latest/webhooks-journal/subscriptions/delete-subscriptions-by-portal.md): Delete a webhook journal subscription for a specific portal. This operation removes the subscription associated with the given portalId, ensuring that no further webhook events are sent for this portal. Use this endpoint to manage and clean up subscriptions that are no longer needed. ## OpenAPI Specs - [account-account-info-v2026-09](/docs/specs/2026-09/account-account-info-v2026-09.json) - [account-audit-logs-v2026-09](/docs/specs/2026-09/account-audit-logs-v2026-09.json) - [business-units-business-units-v2026-09](/docs/specs/2026-09/business-units-business-units-v2026-09.json) - [meta-origins-v2026-09](/docs/specs/2026-09/meta-origins-v2026-09.json) - [settings-multicurrency-v2026-09](/docs/specs/2026-09/settings-multicurrency-v2026-09.json) - [settings-tax-rates-v2026-09](/docs/specs/2026-09/settings-tax-rates-v2026-09.json) - [settings-teams-v2026-09](/docs/specs/2026-09/settings-teams-v2026-09.json) - [settings-user-provisioning-v2026-09](/docs/specs/2026-09/settings-user-provisioning-v2026-09.json) - [crm-app-uninstalls-v2026-09](/docs/specs/2026-09/crm-app-uninstalls-v2026-09.json) - [crm-public-app-feature-flags-v3-v2026-09](/docs/specs/2026-09/crm-public-app-feature-flags-v3-v2026-09.json) - [auth-oauth-v2026-09](/docs/specs/2026-09/auth-oauth-v2026-09.json) - [automation-email-templates-v2026-09](/docs/specs/2026-09/automation-email-templates-v2026-09.json) - [automation-sequences-v2026-09](/docs/specs/2026-09/automation-sequences-v2026-09.json) - [automation-actions-v4-v2026-09](/docs/specs/2026-09/automation-actions-v4-v2026-09.json) - [cms-authors-v2026-09](/docs/specs/2026-09/cms-authors-v2026-09.json) - [cms-blog-settings-v2026-09](/docs/specs/2026-09/cms-blog-settings-v2026-09.json) - [cms-posts-v2026-09](/docs/specs/2026-09/cms-posts-v2026-09.json) - [cms-tags-v2026-09](/docs/specs/2026-09/cms-tags-v2026-09.json) - [cms-cms-content-audit-v2026-09](/docs/specs/2026-09/cms-cms-content-audit-v2026-09.json) - [cms-domains-v2026-09](/docs/specs/2026-09/cms-domains-v2026-09.json) - [cms-hubdb-v2026-09](/docs/specs/2026-09/cms-hubdb-v2026-09.json) - [cms-media-bridge-v2026-09](/docs/specs/2026-09/cms-media-bridge-v2026-09.json) - [cms-pages-v2026-09](/docs/specs/2026-09/cms-pages-v2026-09.json) - [cms-site-search-v2026-09](/docs/specs/2026-09/cms-site-search-v2026-09.json) - [cms-source-code-v2026-09](/docs/specs/2026-09/cms-source-code-v2026-09.json) - [cms-url-mappings-v2026-09](/docs/specs/2026-09/cms-url-mappings-v2026-09.json) - [cms-url-redirects-v2026-09](/docs/specs/2026-09/cms-url-redirects-v2026-09.json) - [communication-preferences-subscriptions-v2026-09](/docs/specs/2026-09/communication-preferences-subscriptions-v2026-09.json) - [conversations-conversations-v2026-09](/docs/specs/2026-09/conversations-conversations-v2026-09.json) - [conversations-custom-channels-v2026-09](/docs/specs/2026-09/conversations-custom-channels-v2026-09.json) - [conversations-visitor-identification-v2026-09](/docs/specs/2026-09/conversations-visitor-identification-v2026-09.json) - [crm-calls-v2026-09](/docs/specs/2026-09/crm-calls-v2026-09.json) - [crm-emails-v2026-09](/docs/specs/2026-09/crm-emails-v2026-09.json) - [crm-meetings-v2026-09](/docs/specs/2026-09/crm-meetings-v2026-09.json) - [crm-notes-v2026-09](/docs/specs/2026-09/crm-notes-v2026-09.json) - [crm-postal-mail-v2026-09](/docs/specs/2026-09/crm-postal-mail-v2026-09.json) - [crm-tasks-series-v2026-09](/docs/specs/2026-09/crm-tasks-series-v2026-09.json) - [crm-tasks-v2026-09](/docs/specs/2026-09/crm-tasks-v2026-09.json) - [crm-associations-v2026-09](/docs/specs/2026-09/crm-associations-v2026-09.json) - [crm-associations-schema-v2026-09](/docs/specs/2026-09/crm-associations-schema-v2026-09.json) - [crm-object-library-v2026-09](/docs/specs/2026-09/crm-object-library-v2026-09.json) - [crm-exports-v2026-09](/docs/specs/2026-09/crm-exports-v2026-09.json) - [crm-calling-extensions-v2026-09](/docs/specs/2026-09/crm-calling-extensions-v2026-09.json) - [crm-public-app-crm-cards-v2026-09](/docs/specs/2026-09/crm-public-app-crm-cards-v2026-09.json) - [crm-transcriptions-v2026-09](/docs/specs/2026-09/crm-transcriptions-v2026-09.json) - [crm-video-conferencing-extension-v2026-09](/docs/specs/2026-09/crm-video-conferencing-extension-v2026-09.json) - [crm-imports-v2026-09](/docs/specs/2026-09/crm-imports-v2026-09.json) - [crm-limits-tracking-v2026-09](/docs/specs/2026-09/crm-limits-tracking-v2026-09.json) - [crm-lists-v2026-09](/docs/specs/2026-09/crm-lists-v2026-09.json) - [crm-appointments-v2026-09](/docs/specs/2026-09/crm-appointments-v2026-09.json) - [crm-carts-v2026-09](/docs/specs/2026-09/crm-carts-v2026-09.json) - [crm-commerce-payments-v2026-09](/docs/specs/2026-09/crm-commerce-payments-v2026-09.json) - [crm-commerce-subscriptions-v2026-09](/docs/specs/2026-09/crm-commerce-subscriptions-v2026-09.json) - [crm-communications-v2026-09](/docs/specs/2026-09/crm-communications-v2026-09.json) - [crm-companies-v2026-09](/docs/specs/2026-09/crm-companies-v2026-09.json) - [crm-contacts-v2026-09](/docs/specs/2026-09/crm-contacts-v2026-09.json) - [crm-contracts-v2026-09](/docs/specs/2026-09/crm-contracts-v2026-09.json) - [crm-courses-v2026-09](/docs/specs/2026-09/crm-courses-v2026-09.json) - [crm-custom-objects-v2026-09](/docs/specs/2026-09/crm-custom-objects-v2026-09.json) - [crm-deal-splits-v2026-09](/docs/specs/2026-09/crm-deal-splits-v2026-09.json) - [crm-deals-v2026-09](/docs/specs/2026-09/crm-deals-v2026-09.json) - [crm-discounts-v2026-09](/docs/specs/2026-09/crm-discounts-v2026-09.json) - [crm-feedback-submissions-v2026-09](/docs/specs/2026-09/crm-feedback-submissions-v2026-09.json) - [crm-fees-v2026-09](/docs/specs/2026-09/crm-fees-v2026-09.json) - [crm-forecast-types-v2026-09](/docs/specs/2026-09/crm-forecast-types-v2026-09.json) - [crm-forecasts-v2026-09](/docs/specs/2026-09/crm-forecasts-v2026-09.json) - [crm-goal-targets-v2026-09](/docs/specs/2026-09/crm-goal-targets-v2026-09.json) - [crm-invoices-v2026-09](/docs/specs/2026-09/crm-invoices-v2026-09.json) - [crm-leads-v2026-09](/docs/specs/2026-09/crm-leads-v2026-09.json) - [crm-line-items-v2026-09](/docs/specs/2026-09/crm-line-items-v2026-09.json) - [crm-listings-v2026-09](/docs/specs/2026-09/crm-listings-v2026-09.json) - [crm-object-tags-v2026-09](/docs/specs/2026-09/crm-object-tags-v2026-09.json) - [crm-objects-v2026-09](/docs/specs/2026-09/crm-objects-v2026-09.json) - [crm-orders-v2026-09](/docs/specs/2026-09/crm-orders-v2026-09.json) - [crm-partner-clients-v2026-09](/docs/specs/2026-09/crm-partner-clients-v2026-09.json) - [crm-partner-services-v2026-09](/docs/specs/2026-09/crm-partner-services-v2026-09.json) - [crm-price-book-items-crm-reads-api-v2026-09](/docs/specs/2026-09/crm-price-book-items-crm-reads-api-v2026-09.json) - [crm-price-books-crm-reads-api-v2026-09](/docs/specs/2026-09/crm-price-books-crm-reads-api-v2026-09.json) - [crm-products-v2026-09](/docs/specs/2026-09/crm-products-v2026-09.json) - [crm-projects-v2026-09](/docs/specs/2026-09/crm-projects-v2026-09.json) - [crm-quotes-v2026-09](/docs/specs/2026-09/crm-quotes-v2026-09.json) - [crm-schemas-v2026-09](/docs/specs/2026-09/crm-schemas-v2026-09.json) - [crm-services-v2026-09](/docs/specs/2026-09/crm-services-v2026-09.json) - [crm-taxes-v2026-09](/docs/specs/2026-09/crm-taxes-v2026-09.json) - [crm-tickets-v2026-09](/docs/specs/2026-09/crm-tickets-v2026-09.json) - [crm-users-v2026-09](/docs/specs/2026-09/crm-users-v2026-09.json) - [crm-crm-owners-v2026-09](/docs/specs/2026-09/crm-crm-owners-v2026-09.json) - [crm-pipelines-v2026-09](/docs/specs/2026-09/crm-pipelines-v2026-09.json) - [crm-pipeline-governance-v2026-09](/docs/specs/2026-09/crm-pipeline-governance-v2026-09.json) - [crm-properties-v2026-09](/docs/specs/2026-09/crm-properties-v2026-09.json) - [crm-property-validations-v2026-09](/docs/specs/2026-09/crm-property-validations-v2026-09.json) - [data-studio-datasource-ingestion-v2026-09](/docs/specs/2026-09/data-studio-datasource-ingestion-v2026-09.json) - [events-manage-event-definitions-v2026-09](/docs/specs/2026-09/events-manage-event-definitions-v2026-09.json) - [events-events-v2026-09](/docs/specs/2026-09/events-events-v2026-09.json) - [events-send-event-completions-v2026-09](/docs/specs/2026-09/events-send-event-completions-v2026-09.json) - [files-files-v2026-09](/docs/specs/2026-09/files-files-v2026-09.json) - [marketing-campaigns-public-api-v2026-09](/docs/specs/2026-09/marketing-campaigns-public-api-v2026-09.json) - [marketing-marketing-emails-v2026-09](/docs/specs/2026-09/marketing-marketing-emails-v2026-09.json) - [marketing-marketing-events-v2026-09](/docs/specs/2026-09/marketing-marketing-events-v2026-09.json) - [marketing-transactional-single-send-v2026-09](/docs/specs/2026-09/marketing-transactional-single-send-v2026-09.json) - [crm-notetaker-conversation-recap-v2026-09](/docs/specs/2026-09/crm-notetaker-conversation-recap-v2026-09.json) - [scheduler-meetings-v2026-09](/docs/specs/2026-09/scheduler-meetings-v2026-09.json) - [commerce-paymentsaccounts-v2026-09](/docs/specs/2026-09/commerce-paymentsaccounts-v2026-09.json) - [commerce-payment-links-v2026-09](/docs/specs/2026-09/commerce-payment-links-v2026-09.json) - [commerce-price-books-v2026-09](/docs/specs/2026-09/commerce-price-books-v2026-09.json) - [webhooks-webhooks-v2026-09](/docs/specs/2026-09/webhooks-webhooks-v2026-09.json) - [webhooks-journal-webhooks-journal-v2026-09](/docs/specs/2026-09/webhooks-journal-webhooks-journal-v2026-09.json)