HubSpot integrationHubSpot logo

HubSpot
for AI agents.

HubSpot integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves HubSpot tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

View source on GitHubAll integrations →
What your agents can do

Real HubSpot actions, managed and audited.

Your user connects HubSpot once; your agent can then manage HubSpot CRM, marketing, CMS, conversations, automation, and developer platform APIs — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

  1. 01Connect

    Your user grants HubSpot access once (OAuth) — the token lands in the vault.

  2. 02Call

    Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.

  3. 03Audit

    Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported HubSpot tools.

Browse 1,123 tools in the HubSpot catalog. Each action uses your configured authentication and tool allowlist.

Showing 1,123 tools.

Get account details for a HubSpot account.
Get account details
Account Info APIv3 [legacy]Details
get-/account-info/2025-09/activity/audit-logs
get-/account-info/2025-09/activity/audit-logs
Account Info API2025-09account-info2025-091activityaudit-logs
get-/account-info/v3/activity/audit-logs
get-/account-info/v3/activity/audit-logs
Audit Logs APIv3 [legacy]1Activity1
Get IP Ranges (JSON)
Retrieves active HubSpot IP addresses in JSON format with detailed information. **Response Properties:** - `cidr` (String): The range of IP addresses used for a specific purpose in HubSpot - `direction` (String): Direction of IP traffic. Values: "INGRESS", "EGRESS" - `service` (String): Nature of the service. Values: "EMAIL", "API", "DNS", "WEB_SCRAPING" - `description` (String): Details about the purpose of the set of IP addresses
HubSpot IP Ranges API
Get IP Ranges (Plaintext)
Retrieves HubSpot's IP address data in plaintext format. This returns just the IP address ranges themselves without additional properties like service, direction, or description. **Required Header:** - `Accept: text/plain` - Must be included to receive plaintext response
HubSpot IP Ranges API
Get login activity for a HubSpot account.
Get login activity.
Audit Logs APIv3 [legacy]1Activity1
Get login activity for a HubSpot account.
Get login activity.
Account Info API2025-09account-info2025-091activitylogin
Get security activity for a HubSpot account
Get security activity
Audit Logs APIv3 [legacy]1Activity1
Get security activity for a HubSpot account
Get security activity
Account Info API2025-09account-info2025-091activitysecurity
Get the daily API usage and limits for a HubSpot account.
Get daily API usage
Account Info APIv3 [legacy]Usage
Retrieve account details
Retrieve account details such as the account type, time zone, currencies, and data hosting location.
Account Info API2026-03 [latest]Basic
Retrieve account details
Retrieve account details such as the account type, time zone, currencies, and data hosting location.
Account Info API2025-09account-info2025-091details
Retrieve audit logs
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-in-a-centralized-audit-log?hubs_content=knowledge.hubspot.com/account-management/view-and-export-account-activity-history&hubs_content-cta=centralized%20audit%20log#data-included-in-the-centralized-audit-log).
Audit Logs API2026-03 [latest]1Basic1
Retrieve login activity
Retrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history).
Audit Logs API2026-03 [latest]1Basic1
Retrieve private app daily API usage
Retrieve the daily API usage for private apps in the account, along with information about usage limits.
Account Info API2026-03 [latest]Basic
Retrieve private app daily API usage
Retrieve the daily API usage for private apps in the account, along with information about usage limits.
Account Info API2025-09account-info2025-091api-usagedailyprivate-apps
Retrieve security history
Retrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history).
Audit Logs API2026-03 [latest]1Basic1
Archive a function for a definition
Archive a function for a definition
Custom Workflow Actions APIFunctions
Completes a callback
Completes a callback
Custom Workflow Actions APICallbacks
Complete a batch of callbacks
Complete a batch of callbacks
Custom Workflow Actions APICallbacks
Create a new custom action definition
Create a new custom action definition
Custom Workflow Actions APIDefinitions
Delete a function for a definition
Delete a function for a definition
Custom Workflow Actions APIFunctions
Delete an action definition
Delete an action definition
Custom Workflow Actions APIDefinitions
delete-/automation/v4/flows/{flow Id}
Fully delete a workflow by ID. Deleted workflows cannot be restored via the API. If you need to restore an accidentally deleted flow, you'll need to contact support.
Workflows V4 APIWorkflows
Enroll a contact in a sequence
Enroll a contact in a sequence
Sequences APIPublic_Enrollments
get-/automation/v4/flows
Retrieve all workflows from an account.
Workflows V4 APIWorkflows
get-/automation/v4/flows/email-campaigns
Retrieve emails sent by a workflow by ID.
Workflows V4 APIEmail campaigns
get-/automation/v4/flows/{flow Id}
Retrieve all details for a specific workflow by ID.
Workflows V4 APIWorkflows
get-/automation/v4/sequences
get-/automation/v4/sequences
Sequences APIPublic_Sequences
Insert a function for a definition
Insert a function for a definition
Custom Workflow Actions APIFunctions
post-/automation/v4/flows
Create a new workflow.
Workflows V4 APIWorkflows
post-/automation/v4/flows/batch/read
Retrieve a batch of workflows by ID.
Workflows V4 APIWorkflows
post-/automation/v4/workflow-id-mappings/batch/read
Retrieve the IDs of v3 workflows that have been migrated to the v4 API.
Workflows V4 APIWorkflow ID mappings
put-/automation/v4/flows/{flow Id}
Update a workflow by ID.
Workflows V4 APIWorkflows
Retrieve a custom action definition
Retrieve a custom action definition
Custom Workflow Actions APIDefinitions
Retrieve a function from a given definition
Retrieve a function from a given definition
Custom Workflow Actions APIFunctions
Retrieve a specific revision of a definition
Retrieve a specific revision of a definition
Custom Workflow Actions APIRevisions
Retrieve custom action definitions
Retrieve custom action definitions
Custom Workflow Actions APIDefinitions
Retrieve details for a sequence
Retrieve details for a sequence
Sequences APIPublic_Sequences
Retrieve functions by a type for a given definition
Retrieve functions by a type for a given definition
Custom Workflow Actions APIFunctions
Retrieve functions for a given definition
Retrieve functions for a given definition
Custom Workflow Actions APIFunctions
Retrieve revisions for a given definition
Retrieve revisions for a given definition
Custom Workflow Actions APIRevisions
Retrieve the enrollment status of a contact
Retrieve the enrollment status of a contact
Sequences APIPublic_Enrollments
Update a function for a definition
Update a function for a definition
Custom Workflow Actions APIFunctions
Update an existing action definition
Update an existing action definition
Custom Workflow Actions APIDefinitions
Add a new row to a table
Add a new row to a HubDB table. New rows will be added to the `draft` version of the table. Use `publish` endpoint to push these changes to published version.
HubDb APIRows
Archive a table
Archive (soft delete) an existing HubDB table. This archives both the published and draft versions.
HubDb APITables
Archive multiple properties
Archive multiple properties
Media Bridge APIProperties
Attach a Blog Author to a multi-language group
Attach a Blog Author to a multi-language group.
Blog Authors APIBlog Authors
Attach a Blog Post to a multi-language group
Attach a Blog Post to a multi-language group.
Blog Posts
Attach a Blog Tag to a multi-language group
Attach a Blog Tag to a multi-language group.
Blog Authors API
Attach a blog to a multi-language group
Attach a blog to a multi-language group.
Blog Settings API
Attach a landing page to a multi-language group
Attach a landing page to a multi-language group.
Pages APILanding Pages
Attach a site page to a multi-language group
Attach a site page to a multi-language group.
Pages APISite Pages
Clone a Blog Post
Clone a Blog Post.
Blog Posts
Clone a Landing Page
Clone a Landing Page
Pages APILanding Pages
Clone a row
Clones a single row in the `draft` version of the table.
HubDb APIRows
Clone a Site Page
Clone a Site Page
Pages APISite Pages
Clone a table
Clone an existing HubDB table. The `newName` and `newLabel` of the new table can be sent as JSON in the `body` parameter. This will create the cloned table as a `draft`.
HubDb APITables
Clone rows in batch
Clones rows in the `draft` version of the specified table, given a set of row ids. Maximum of 100 row ids per call.
HubDb APIRows Batch
Create a batch of Blog Authors
Create the Blog Author objects detailed in the request body.
Blog Authors APIBlog Authors
Create a batch of Blog Posts
Create the Blog Post objects detailed in the request body.
Blog Posts
Create a batch of Blog Tags
Create the Blog Tag objects detailed in the request body.
Blog Authors API
Create a batch of Folders
Create the Folder objects detailed in the request body.
Pages APILanding Pages
Create a batch of Landing Pages
Create the Landing Page objects detailed in the request body.
Pages APILanding Pages
Create a batch of Site Pages
Create the Site Page objects detailed in the request body.
Pages APISite Pages
Create a new A/B test variation
Create a new A/B test variation based on the information provided in the request body.
Pages APISite Pages
Create a new A/B test variation
Create a new A/B test variation based on the information provided in the request body.
Pages APILanding Pages
Create a new Blog Author
Create a new Blog Author.
Blog Authors APIBlog Authors
Create a new Blog Post
Create a new Blog Post.
Blog Posts
Create a new Blog Tag
Create a new Blog Tag.
Blog Authors API
Create a new Folder
Create a new Folder
Pages APILanding Pages
Create a new Landing Page
Create a new Landing Page
Pages APILanding Pages
Create a new language variation
Create a new language variation from an existing blog
Blog Settings API
Create a new language variation
Create a new language variation from an existing Blog Tag
Blog Authors API
Create a new language variation
Create a new language variation from an existing site page
Pages APISite Pages
Create a new language variation
Create a new language variation from an existing landing page
Pages APILanding Pages
Create a new language variation
Create a new language variation from an existing Blog Author.
Blog Authors APIBlog Authors
Create a new language variation
Create a new language variation from an existing Blog Post
Blog Posts
Create a new object type
Create a new object type
Media Bridge APIIntegrator_Settings
Create a new property
Create a new property
Media Bridge APIProperties
Create a new property group
Create a new property group
Media Bridge APIGroups
Create a new Site Page
Create a new Site Page
Pages APISite Pages
Create a new table
Creates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.
HubDb APITables
Create an attention span event
Create an attention span event
Media Bridge APIEvents
Create a played event
Create a played event
Media Bridge APIEvents
Create a quartile event
Create a quartile event
Media Bridge APIEvents
Create a redirect
Creates and configures a new URL redirect.
URL Redirects APIRedirects
Create association definition
Create association definition
Media Bridge APISchemas
Create multiple properties
Create multiple properties
Media Bridge APIProperties
Create or update event visibility settings
Create or update event visibility settings
Media Bridge APIIntegrator_Settings
Create rows in batch
Creates rows in the `draft` version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example.
HubDb APIRows Batch
Delete a batch of Blog Authors
Delete the Blog Author objects identified in the request body.
Blog Authors APIBlog Authors
Delete a batch of Blog Posts
Delete the Blog Post objects identified in the request body. Note: This is not the same as the in-app `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to true.
Blog Posts
Delete a batch of Blog Tags
Delete the Blog Tag objects identified in the request body.
Blog Authors API
Delete a batch of Folders
Delete the Folder objects identified in the request body.
Pages APILanding Pages
Delete a batch of Landing Pages
Delete the Landing Page objects identified in the request body. Note: This is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to true.
Pages APILanding Pages
Delete a batch of Site Pages
Delete the Site Page objects identified in the request body. Note: This is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to true.
Pages APISite Pages
Delete a Blog Author
Delete the Blog Author object identified by the id in the path.
Blog Authors APIBlog Authors
Delete a Blog Post
Delete the Blog Post object identified by the id in the path.
Blog Posts
Delete a Blog Tag
Delete the Blog Tag object identified by the id in the path.
Blog Authors API
Delete a file
Deletes the file at the specified path in the specified environment.
CMS Source Code APIContent
Delete a Folder
Delete the Folder object identified by the id in the path.
Pages APILanding Pages
Delete a Landing Page
Delete the Landing Page object identified by the id in the path.
Pages APILanding Pages
Delete an association definition
Delete an association definition
Media Bridge APISchemas
Delete an oEmbed domain
Delete an oEmbed domain
Media Bridge APIIntegrator_Settings
Delete a property
Delete a property
Media Bridge APIProperties
Delete a property group
Delete a property group
Media Bridge APIGroups
Delete a redirect
Delete one existing redirect, so it is no longer mapped.
URL Redirects APIRedirects
Delete a Site Page
Delete the Site Page object identified by the id in the path.
Pages APISite Pages
Detach a Blog Author from a multi-language group
Detach a Blog Author from a multi-language group.
Blog Authors APIBlog Authors
Detach a blog from a multi-language group
Detach a blog from a multi-language group.
Blog Settings API
Detach a Blog Post from a multi-language group
Detach a Blog Post from a multi-language group.
Blog Posts
Detach a Blog Tag from a multi-language group
Detach a Blog Tag from a multi-language group.
Blog Authors API
Detach a landing page from a multi-language group
Detach a landing page from a multi-language group.
Pages APILanding Pages
Detach a site page from a multi-language group
Detach a site page from a multi-language group.
Pages APISite Pages
Download a file
Downloads the byte contents of the file at the specified path in the specified environment.
CMS Source Code APIContent
End an active A/B test
End an active A/B test and designate a winner.
Pages APISite Pages
End an active A/B test
End an active A/B test and designate a winner.
Pages APILanding Pages
Export a draft table
Exports the `draft` version of a table to CSV / EXCEL format.
HubDb APITables
Export a published version of a table
Exports the `published` version of a table to CSV / EXCEL format.
HubDb APITables
Extract a zip file
Extract a zip file
CMS Source Code APISource_Code_Extract
Get all Blogs
Get the list of Blogs. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Blog Settings API
Get all Blog Authors
Get the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Blog Authors APIBlog Authors
Get all Blog Posts
Get the list of blog posts. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Blog Posts
Get all Blog Tags
Get the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Blog Authors API
Get all Landing Pages
Get the list of landing pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Pages APILanding Pages
Get all Landing Page Folders
Get the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Pages APILanding Pages
Get all published tables
Returns the details for the `published` version of each table defined in an account, including column definitions.
HubDb APITables
Get all schemas
Get all schemas
Media Bridge APISchemas
Get all Site Pages
Get the list of site pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Pages APISite Pages
Get an oEmbed domain
Get an oEmbed domain
Media Bridge APIIntegrator_Settings
Get a row from the draft table
Get a single row by ID from a table's `draft` version.
HubDb APIRows
Get a set of rows
Returns rows in the `published` version of the specified table, given a set of row ids. **Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access.
HubDb APIRows Batch
Get a set of rows from draft table
Returns rows in the `draft` version of the specified table, given a set of row ids.
HubDb APIRows Batch
Get a single domain
Returns a single domains with the id specified.
Domains APIDomains
Get a specific property group
Get a specific property group
Media Bridge APIGroups
Get a table row
Get a single row by ID from a table's `published` version. **Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.
HubDb APIRows
Get current domains
Returns all existing domains that have been created. Results can be limited and filtered by creation or updated date.
Domains APIDomains
Get current redirects
Returns all existing URL redirects. Results can be limited and filtered by creation or updated date.
URL Redirects APIRedirects
Get details for a draft table
Get the details for the `draft` version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.
HubDb APITables
Get details for a redirect
Returns the details for a single existing URL redirect by ID.
URL Redirects APIRedirects
Get details of a published table
Returns the details for the `published` version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table. **Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access.
HubDb APITables
Get extraction status
Get extraction status
CMS Source Code APISource_Code_Extract
Get indexed properties.
For a given account and document ID (page ID, blog post ID, HubDB row ID, etc.), return all indexed data for that document. This is useful when debugging why a particular document is not returned from a custom search.
Site Search APIPublic
Get object types for a supported media
Get object types for a supported media
Media Bridge APIIntegrator_Settings
Get oEmbed domains
Get oEmbed domains
Media Bridge APIIntegrator_Settings
Get property groups
Get property groups
Media Bridge APIGroups
Get rows for a table
Returns a set of rows in the `published` version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options. **Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.
HubDb APIRows
Get rows from draft table
Returns rows in the `draft` version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.
HubDb APIRows
Get the details for a property
Get the details for a property
Media Bridge APIProperties
Get the details for multiple properties
Get the details for multiple properties
Media Bridge APIProperties
Get the metadata for a file
Gets the metadata object for the file at the specified path in the specified environment.
CMS Source Code APIMetadata
Get the properties for an object type.
Get the properties for an object type.
Media Bridge APIProperties
Get the schema for an object type
Get the schema for an object type
Media Bridge APISchemas
Permanently deletes a row
Permanently deletes a row from a table's `draft` version.
HubDb APIRows
Permanently deletes rows
Permanently deletes rows from the `draft` version of the table, given a set of row ids. Maximum of 100 row ids per call.
HubDb APIRows Batch
Publish a table from draft
Publishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated.
HubDb APITables
Push Blog Post draft edits live
Take any changes from the draft version of the Blog Post and apply them to the live version.
Blog Posts
Push Landing Page draft edits live
Take any changes from the draft version of the Landing Page and apply them to the live version.
Pages APILanding Pages
Push Site Page draft edits live
Take any changes from the draft version of the Site Page and apply them to the live version.
Pages APISite Pages
Query audit logs
Returns audit logs based on filters.
Content Audit APIAudit_Logs
Register the media bridge app name
Register the media bridge app name
Media Bridge APIIntegrator_Settings
Replaces an existing row
Replace a single row in the table's `draft` version. All the column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted. See the `Create a row` endpoint for instructions on how to format the JSON row definitions.
HubDb APIRows
Replace rows in batch in draft table
Replaces multiple rows as a batch in the `draft` version of the table, with a maximum of 100 rows per call. See the endpoint `PUT /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.
HubDb APIRows Batch
Rerun a previous A/B test
Rerun a previous A/B test.
Pages APISite Pages
Rerun a previous A/B test
Rerun a previous A/B test.
Pages APILanding Pages
Reset a draft table
Replaces the data in the `draft` version of the table with values from the `published` version. Any unpublished changes in the `draft` will be lost after this call is made.
HubDb APITables
Reset the Blog Post draft to the live version
Discards any edits and resets the draft to the live version.
Blog Posts
Reset the Landing Page draft to the live version
Discards any edits and resets the draft to the live version.
Pages APILanding Pages
Reset the Site Page draft to the live version
Discards any edits and resets the draft to the live version.
Pages APISite Pages
Restore a previous version of a blog post
Takes a specified version of a blog post and restores it.
Blog Posts
Restore a previous version of a blog post, to the draft version of the blog post
Takes a specified version of a blog post, sets it as the new draft version of the blog post.
Blog Posts
Restore a previous version of a Folder
Takes a specified version of a Folder and restores it.
Pages APILanding Pages
Restore a previous version of a Landing Page
Takes a specified version of a Landing Page and restores it.
Pages APILanding Pages
Restore a previous version of a Landing Page, to the draft version of the Landing Page
Takes a specified version of a Landing Page, sets it as the new draft version of the Landing Page.
Pages APILanding Pages
Restore a previous version of a Site Page
Takes a specified version of a Site Page and restores it.
Pages APISite Pages
Restore a previous version of a Site Page, to the draft version of the Site Page
Takes a specified version of a Site Page, sets it as the new draft version of the Site Page.
Pages APISite Pages
Retrieves all the previous versions of a Blog
Retrieves all the previous versions of a Blog
Blog Settings API
Retrieves all the previous versions of a blog post
Retrieves all the previous versions of a blog post.
Blog Posts
Retrieves all the previous versions of a Folder
Retrieves all the previous versions of a Folder.
Pages APILanding Pages
Retrieves all the previous versions of a Landing Page
Retrieves all the previous versions of a Landing Page.
Pages APILanding Pages
Retrieves all the previous versions of a Site Page
Retrieves all the previous versions of a Site Page.
Pages APISite Pages
Retrieves a previous version of a Blog
Retrieves a previous version of a Blog
Blog Settings API
Retrieves a previous version of a blog post
Retrieves a previous version of a blog post.
Blog Posts
Retrieves a previous version of a Folder
Retrieves a previous version of a Folder
Pages APILanding Pages
Retrieves a previous version of a Landing Page
Retrieves a previous version of a Landing Page
Pages APILanding Pages
Retrieves a previous version of a Site Page
Retrieves a previous version of a Site Page
Pages APISite Pages
Retrieve a batch of Blog Authors
Retrieve the Blog Author objects identified in the request body.
Blog Authors APIBlog Authors
Retrieve a batch of Blog Posts
Retrieve the Blog Post objects identified in the request body.
Blog Posts
Retrieve a batch of Blog Tags
Retrieve the Blog Tag objects identified in the request body.
Blog Authors API
Retrieve a batch of Folders
Update the Folder objects identified in the request body.
Pages APILanding Pages
Retrieve a batch of Landing Pages
Retrieve the Landing Page objects identified in the request body.
Pages APILanding Pages
Retrieve a batch of Site Pages
Retrieve the Site Page objects identified in the request body.
Pages APISite Pages
Retrieve a Blog
Retrieve the Blog object identified by the id in the path.
Blog Settings API
Retrieve a Blog Author
Retrieve the Blog Author object identified by the id in the path.
Blog Authors APIBlog Authors
Retrieve a Blog Post
Retrieve the Blog Post object identified by the id in the path.
Blog Posts
Retrieve a Blog Tag
Retrieve the Blog Tag object identified by the id in the path.
Blog Authors API
Retrieve a Folder
Retrieve the Folder object identified by the id in the path.
Pages APILanding Pages
Retrieve a Landing Page
Retrieve the Landing Page object identified by the id in the path.
Pages APILanding Pages
Retrieve a Site Page
Retrieve the Site Page object identified by the id in the path.
Pages APISite Pages
Retrieve the full draft version of the Blog Post
Retrieve the full draft version of the Blog Post.
Blog Posts
Retrieve the full draft version of the Landing Page
Retrieve the full draft version of the Landing Page.
Pages APILanding Pages
Retrieve the full draft version of the Site Page
Retrieve the full draft version of the Site Page.
Pages APISite Pages
Return all draft tables
Returns the details for each draft table defined in the specified account, including column definitions.
HubDb APITables
Schedule a Blog Post to be Published
Schedule a Blog Post to be Published.
Blog Posts
Schedule a Landing Page to be Published
Schedule a Landing Page to be Published
Pages APILanding Pages
Schedule a Site Page to be Published
Schedule a Site Page to be Published
Pages APISite Pages
Search your site.
Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path.
Site Search APIPublic
Set a new primary language
Set a blog as the primary language of a multi-language group.
Blog Settings API
Set a new primary language
Set a Blog Tag as the primary language of a multi-language group.
Blog Authors API
Set a new primary language
Set a site page as the primary language of a multi-language group.
Pages APISite Pages
Set a new primary language
Set a landing page as the primary language of a multi-language group.
Pages APILanding Pages
Set a new primary language
Set a Blog Author as the primary language of a multi-language group.
Blog Authors APIBlog Authors
Set a new primary language
Set a Blog Post as the primary language of a multi-language group.
Blog Posts
Set up a new oEmbed domain
Set up a new oEmbed domain
Media Bridge APIIntegrator_Settings
Unpublish a table
Unpublishes the table, meaning any website pages using data from the table will not render any data.
HubDb APITables
Updates an existing row
Sparse updates a single row in the table's `draft` version. All the column values need not be specified. Only the columns or fields that needs to be modified can be specified. See the `Create a row` endpoint for instructions on how to format the JSON row definitions.
HubDb APIRows
Update a batch of Blog Authors
Update the Blog Author objects identified in the request body.
Blog Authors APIBlog Authors
Update a batch of Blog Posts
Update the Blog Post objects identified in the request body.
Blog Posts
Update a batch of Blog Tags
Update the Blog Tag objects identified in the request body.
Blog Authors API
Update a batch of Folders
Update the Folder objects identified in the request body.
Pages APILanding Pages
Update a batch of Landing Pages
Update the Landing Page objects identified in the request body.
Pages APILanding Pages
Update a batch of Site Pages
Update the Site Page objects identified in the request body.
Pages APISite Pages
Update a Blog Author
Sparse updates a single Blog Author object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified.
Blog Authors APIBlog Authors
Update a Blog Post
Sparse updates a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified.
Blog Posts
Update a Blog Post draft
Sparse updates the draft version of a single Blog Post object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified.
Blog Posts
Update a Blog Tag
Sparse updates a single Blog Tag object identified by the id in the path. All the column values need not be specified. Only the that need to be modified can be specified.
Blog Authors API
Update a Folder
Sparse updates a single Folder object identified by the id in the path. You only need to specify the column values that you are modifying.
Pages APILanding Pages
Update a Landing Page
Sparse updates a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying.
Pages APILanding Pages
Update a Landing Page draft
Sparse updates the draft version of a single Landing Page object identified by the id in the path. You only need to specify the column values that you are modifying.
Pages APILanding Pages
Update an existing table
Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the `draft` verion of the table. Use `publish` endpoint to push all the changes to the `published` version. To restore a table, include the query parameter `archived=true` and `"archived": false` in the json body. **Note:** You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.
HubDb APITables
Update an oEmbed domain
Update an oEmbed domain
Media Bridge APIIntegrator_Settings
Update a property
Update a property
Media Bridge APIProperties
Update a property group
Update a property group
Media Bridge APIGroups
Update a redirect
Updates the settings for an existing URL redirect.
URL Redirects APIRedirects
Update a Site Page
Sparse updates a single Site Page object identified by the id in the path. You only need to specify the column values that you are modifying.
Pages APISite Pages
Update a Site Page draft
Sparse updates the draft version of a single Site Page object identified by the id in the path. You only need to specify the column values that you are modifying.
Pages APISite Pages
Update languages of multi-language group
Explicitly set new languages for each blog in a multi-language group.
Blog Settings API
Update languages of multi-language group
Explicitly set new languages for each Blog Tag in a multi-language group.
Blog Authors API
Update languages of multi-language group
Explicitly set new languages for each site page in a multi-language group.
Pages APISite Pages
Update languages of multi-language group
Explicitly set new languages for each landing page in a multi-language group.
Pages APILanding Pages
Update languages of multi-language group
Explicitly set new languages for each Blog Author in a multi-language group.
Blog Authors APIBlog Authors
Update languages of multi-language group
Explicitly set new languages for each Blog Post in a multi-language group.
Blog Posts
Update rows in batch in draft table
Updates multiple rows as a batch in the `draft` version of the table, with a maximum of 100 rows per call. See the endpoint `PATCH /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.
HubDb APIRows Batch
Update the media bridge app name
Update the media bridge app name
Media Bridge APIIntegrator_Settings
Update the schema for an object type
Update the schema for an object type
Media Bridge APISchemas
View event visibility settings
View event visibility settings
Media Bridge APIIntegrator_Settings
Archives a thread.
Archives a single thread. The thread will be permanently deleted 30 days after placed in an archived state.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Archive a custom channel
Use this API to archive a registered custom channel
Custom Channels APIv3 [legacy]1
Archive a custom channel
Archive an existing registered custom channel
Custom Channels APIv2026-03 [latest]Channels
Batch retrieve actors
Retrieve information about multiple actors in a batch operation. This endpoint is useful for obtaining details about several actors at once, which can help in managing or analyzing actor data efficiently.
Conversations Inbox & Messages API2026-09-beta [latest]Batch
Create a channel account
This API allows you to create one or more accounts that all talk over a single channel but using different delivery identifiers.
Custom Channels APIv3 [legacy]1External_Channel_Accounts
Create a channel account
Create a new account for a channel. Multiple accounts can communicate over a single channel using different delivery identifiers.
Custom Channels APIv2026-03 [latest]Channel accounts
Create a custom channel
Register a new channel along with its capabilities and the webhook url that will be used to receive messages published over the channel
Custom Channels APIv3 [legacy]1External_Channels
Create message
Create a new message within a specific conversation thread in your HubSpot account. This endpoint allows you to send messages as part of an ongoing conversation, which can include various types of content such as text, attachments, and more. It is useful for programmatically interacting with conversation threads and ensuring seamless communication flow.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Delete Assignee
Remove the assignee from a specific conversation thread in your HubSpot account. This operation is useful when you want to unassign a user from handling a particular thread, potentially allowing it to be reassigned to another user or left unassigned.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Delete thread
Delete a specific conversation thread in your HubSpot account. This operation will permanently remove the thread identified by the threadId from the system. It is useful for managing and cleaning up conversation data.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Get accounts for a channel
Get accounts for a channel
Custom Channels APIv3 [legacy]1External_Channel_Accounts
Get accounts for a channel
Retrieve a list of accounts for a custom channel.
Custom Channels APIv2026-03 [latest]Channel accounts
Get a channel account by id
Retrieve a PublicChannelAccount that contains all the metadata about your channel account. This includes information like its channel, associated inbox id, and delivery identifier information.
Custom Channels APIv3 [legacy]1External_Channel_Accounts
Get a channel account by id
Retrieve the details for a specific channel account. This contains all the metadata about your channel account, including its channel, associated inbox id, and delivery identifier information.
Custom Channels APIv2026-03 [latest]Channels
Get actors
Resolve `ActorId`s to the underlying actors/participants.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get a custom channel
Retrieve the details about a custom channel. This API allows you to see a custom channel's current capabilties and other configuration metadata
Custom Channels APIv3 [legacy]1External_Channels
Get a custom channel
Retrieve the details about a custom channel. This API allows you to see a custom channel's current capabilties and other configuration metadata
Custom Channels APIv2026-03 [latest]Channels
Get all channels for app
Get all channels for app
Custom Channels APIv3 [legacy]1External_Channels
Get a message
Get the PublicConversationsMessage that represents a message sent over a custom channel
Custom Channels APIv3 [legacy]1External_Messages
Get a message
Get the details for a specific message sent over a custom channel
Custom Channels APIv2026-03 [latest]Messages
Get a single actor.
Get a single actor.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get a single channel.
Get a single channel.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get a single channel account.
Get a single channel account.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get a single conversations inbox.
Get a single conversations inbox.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get a single message.
Get a single message.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get a single thread.
Returns a single thread.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get channels.
Get channels.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get channel accounts.
Get channel accounts.
Conversations Inbox & Messages APIv3 [legacy]Conversations
get-/conversations/custom-channels/2026-03_/conversations/custom-channels/v3
get-/conversations/custom-channels/2026-03_/conversations/custom-channels/v3
Custom Channels APIv2026-03 [latest]Basic1
Get conversations inboxes.
Get conversations inboxes.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get message history for a thread.
Get message history for a thread.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get the original content of a single message.
Returns the complete original text and rich text bodies of a message. This will be different from the text and rich text in the message itself if the message's `truncationStatus` is anything other than `NOT_TRUNCATED`.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Get threads.
Get threads.
Conversations Inbox & Messages APIv3 [legacy]Conversations
List Channels
Retrieve a list of channels available in the HubSpot account. This endpoint supports pagination and sorting, allowing you to manage and organize the channel data effectively. Use this endpoint to access detailed information about each channel, which can be useful for integrating or managing communication platforms within your HubSpot environment.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
List channel accounts
Retrieve a list of channel accounts associated with conversations in your HubSpot account. This endpoint allows you to filter results by channel ID, inbox ID, and other parameters. It supports pagination and sorting to help manage large sets of data effectively.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
List inboxes
Retrieve a list of inboxes in your HubSpot account. This endpoint allows you to paginate through results, set limits on the number of results per page, sort the results, and filter by archived status. Useful for managing and viewing all inboxes associated with your account.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
post-/conversations/custom-channels/2026-03_/conversations/custom-channels/v3
post-/conversations/custom-channels/2026-03_/conversations/custom-channels/v3
Custom Channels APIv2026-03 [latest]Basic1
Publish a message
Publish a message over your custom channel
Custom Channels APIv3 [legacy]1External_Messages
Publish a message
Publish a message over your custom channel
Custom Channels APIv2026-03 [latest]Messages
Retrieve actor
Retrieve details of a specific actor in the conversations API by providing the actor's unique identifier. This endpoint is useful for obtaining information about a particular actor involved in conversations, such as agents, bots, or visitors.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve channel
Retrieve details of a specific channel in the HubSpot conversations API. This endpoint is useful for accessing information about a channel using its unique identifier.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve channel account
Retrieve details of a specific channel account using its unique identifier. This endpoint allows you to access information about a channel account, which can be useful for managing or integrating communication channels within your HubSpot account.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve inbox
Retrieve details of a specific inbox in your HubSpot account using the inbox ID. This endpoint allows you to access information about the inbox, including whether it is archived. It is useful for managing and organizing your communication channels within HubSpot.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve message
Retrieve a specific message from a conversation thread in your HubSpot account. This endpoint allows you to access the details of a message by specifying the thread and message identifiers. It is useful for fetching message content and properties for further analysis or display.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve messages
Retrieve messages from a specific conversation thread in your HubSpot account. This endpoint allows you to paginate through messages, sort them, and filter based on archival status. It is useful for accessing the message history of a conversation thread.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve message content
Retrieve the original content of a specific message within a conversation thread. This endpoint is useful for accessing the initial message content before any modifications or formatting changes. It can be particularly helpful for auditing or reviewing the original message details.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve thread
Retrieve a specific conversation thread by its unique identifier. This endpoint allows you to access detailed information about the thread, including its properties and associations. It can be useful for reviewing the content and status of a conversation thread within your HubSpot account.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Retrieve threads
Retrieve a list of conversation threads from the specified inboxes in your HubSpot account. This endpoint allows you to filter threads by associated contacts, tickets, status, and more. Useful for managing and reviewing communication threads efficiently.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Send a message to a thread.
Send a new message on a thread at the current timestamp.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Update a channel account
This API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account.
Custom Channels APIv3 [legacy]1External_Channel_Accounts
Update a channel account
This API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account.
Custom Channels APIv2026-03 [latest]Channel accounts
Update a custom channel
This endpoint can be used to update a channel's capabilities. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.
Custom Channels APIv3 [legacy]1External_Channels
Update a custom channel
Update the capabilities for an existing. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.
Custom Channels APIv2026-03 [latest]Channels
Update a message
Use this API to update a message's status to indicate if it was successfully sent, failed to send, or was read
Custom Channels APIv3 [legacy]1External_Messages
Update a message
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.
Custom Channels APIv2026-03 [latest]Messages
Update assignee
Assign a specific actor to a conversation thread in your HubSpot account. This operation allows you to set or change the assignee for a thread, which can help in managing and organizing conversations more effectively.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Update a thread.
Updates a single thread. Either a thread's status can be updated, or the thread can be restored.
Conversations Inbox & Messages APIv3 [legacy]Conversations
Update thread
Update the details of a specific thread in the conversations API. This operation allows you to modify the status or archived state of a thread identified by its threadId. Use this endpoint to manage thread lifecycle events such as closing or reopening a conversation.
Conversations Inbox & Messages API2026-09-beta [latest]Basic
Add All Records from a Source List to a Destination List
Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The *destination* and *source list* IDs must be different. The *destination* and *source lists* must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processingType`.
Lists APIMemberships
Add and/or Remove Records from a List
Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
Lists APIMemberships
Add Records to a List
Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
Lists APIMemberships
Archive
Move an Object identified by `{cartId}` to the recycling bin.
Carts APIBasic1
Archive
Move an Object identified by `{commercePaymentId}` to the recycling bin.
Commerce Payments APIBasic12
Archive
Move an Object identified by `{productId}` to the recycling bin.
Products APIBasic1234567891011121314151617
Archive
Move an Object identified by `{quoteId}` to the recycling bin.
Quotes APIBasic123456789101112131415161718
Archive
Move an Object identified by `{taxId}` to the recycling bin.
Taxes APIBasic12345678910111213141516171819
Archive
Move an Object identified by `{ticketId}` to the recycling bin.
Tickets APIBasic1234567891011121314151617181920
Archive
Move an Object identified by `{invoiceId}` to the recycling bin.
Invoices API
Archive
Move an Object identified by `{courseId}` to the recycling bin.
Courses API
Archive
Move an Object identified by `{appointmentId}` to the recycling bin.
Appointments API
Archive
Move an Object identified by `{listingId}` to the recycling bin.
Listings API
Archive
Move an Object identified by `{serviceId}` to the recycling bin.
Services API
Archive
Move an Object identified by `{projectId}` to the recycling bin.
Projects APIBasic123456789101112131415161718192021222324252627
Archive
Move an Object identified by `{subscriptionId}` to the recycling bin.
Commerce Subscriptions API
Archive
Move an Object identified by `{objectId}` to the recycling bin.
Objects APIBasic1234567891011121314
Archive
Move an Object identified by `{dealId}` to the recycling bin.
Deals API
Archive
Move an Object identified by `{discountId}` to the recycling bin.
Discounts APIBasic123456789
Archive
Move an Object identified by `{feeId}` to the recycling bin.
Fees APIBasic1234567891011
Archive
Move an Object identified by `{leadsId}` to the recycling bin.
Leads APIBasic123456789101112
Archive
Move an Object identified by `{lineItemId}` to the recycling bin.
Line Items APIBasic12345678910111213
Archive
Move an Object identified by `{orderId}` to the recycling bin.
Orders APIBasic123456789101112131415
Archive a batch of appointments by ID
Archive multiple appointments using their IDs.
Appointments API
Archive a batch of carts by ID
Archive a batch of carts by ID
Carts APIBatch123
Archive a batch of commerce payments by ID
Archive a batch of commerce payments by ID
Commerce Payments APIBatch1234
Archive a batch of companies
Archive a batch of companies
Companies APIBatch123456
Archive a batch of contacts
Archive a batch of contacts
Contacts APIBatch1234567
Archive a batch of courses by ID
Archive a batch of objects
Courses API
Archive a batch of deals by ID
Archive multiple deals using their IDs.
Deals API
Archive a batch of discounts by ID
Archive a batch of discounts by ID
Discounts APIBatch1234567891011
Archive a batch of fees by ID
Archive a batch of fees by ID
Fees APIBatch12345678910111213
Archive a batch of goal targets by ID
Archive multiple goal targets in a single batch operation using their IDs.
Goals APIv3 [legacy]
Archive a batch of invoices by ID
Archive a batch of invoices by ID
Invoices API
Archive a batch of leads by ID
Archive a batch of leads by ID
Leads APIBatch1234567891011121314
Archive a batch of line items by ID
Archive a batch of line items by ID
Line Items APIBatch123456789101112131415
Archive a batch of listings by ID
Archive multiple listings by their IDs.
Listings API
Archive a batch of objects by ID
Archive a batch of objects by ID
Objects APIBatch12345678910111213141516
Archive a batch of orders by ID
Archive a batch of orders by ID
Orders APIBatch1234567891011121314151617
Archive a batch of products by ID
Archive a batch of products by ID
Products APIBatch12345678910111213141516171819
Archive a batch of projects
Archive multiple projects using their IDs.
Projects APIBatch123456789101112131415161718192021222324252627282930
Archive a batch of properties
Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).
Properties APIBatch12345678910111213141516171819202122232425
Archive a batch of quotes by ID
Archive a batch of quotes by ID
Quotes APIBatch1234567891011121314151617181920
Archive a batch of services by ID
Archive a batch of objects
Services API
Archive a batch of subscriptions by ID
Archive a batch of subscriptions by ID
Commerce Subscriptions API
Archive a batch of taxes by ID
Archive a batch of taxes by ID
Taxes APIBatch123456789101112131415161718192021
Archive a batch of tickets by ID
Archive a batch of tickets by ID
Tickets APIBatch12345678910111213141516171819202122
Archive a company
Move an Object identified by `{companyId}` to the recycling bin.
Companies APIBasic1234
Archive a contact
Move an Object identified by `{contactId}` to the recycling bin.
Contacts APIBasic12345
Archive a property
Move a property identified by {propertyName} to the recycling bin.
Properties APICore12
Archive a property group
Move a property group identified by {groupName} to the recycling bin.
Properties APIGroups
Archive multiple associations between specified object types in a batch operation.
Remove the associations between all pairs of objects identified in the request body.
Associations V3 APIBatch
Associate a partner client with another object
Associate a partner client with another object
Partner Clients API
Associate a partner service with another object
Associate a partner service with another object
Partner Services APIAssociations1
Batch delete account flag state
Batch delete account flag state
Feature Flags APIfeature-flagsv3{appId}flags{flagName}portalsbatchdelete
Batch set account flag state
Batch set account flag state
Feature Flags APIfeature-flagsv3{appId}flags{flagName}portalsbatchupsert
Cancel an active import
This allows a developer to cancel an active import.
Imports APICore1
Cancel the conversion of a list
Delete an existing scheduled conversion for a list.
Lists API
Create
Batch create associations for objects
Flexible Associations V4 APIBatch12
Create
Set association labels between two records.
Flexible Associations V4 APIAssociations
Create
Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.
Line Items APIBasic12345678910111213
Create
Create a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided.
Orders APIBasic123456789101112131415
Create
Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.
Products APIBasic1234567891011121314151617
Create
Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided.
Quotes APIBasic123456789101112131415161718
Create
Create a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided.
Taxes APIBasic12345678910111213141516171819
Create
Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.
Tickets APIBasic1234567891011121314151617181920
Create
Create a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided.
Invoices API
Create
Create a course with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard courses is provided.
Courses API
Create
Create a appointment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard appointments is provided.
Appointments API
Create
Create a listing with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard listings is provided.
Listings API
Create
Create a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided.
Carts APIBasic1
Create
Create a service with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard services is provided.
Services API
Create
Create a project with the given properties and return a copy of the object, including the ID.
Projects APIBasic123456789101112131415161718192021222324252627
Create
Create a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided.
Goals APIv3 [legacy]
Create
Create a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided.
Commerce Payments APIBasic12
Create
Create a subscription with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard subscriptions is provided.
Commerce Subscriptions API
Create
Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.
Objects APIBasic1234567891011121314
Create
Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.
Deals API
Create
Create a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided.
Discounts APIBasic123456789
Create
Create a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided.
Fees APIBasic1234567891011
Create
Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.
Leads APIBasic123456789101112
Creates a folder
Creates a folder with the given information.
Lists API
Create a batch of appointments
Create multiple appointments in a single request.
Appointments API
Create a batch of carts
Create a batch of carts
Carts APIBatch123
Create a batch of commerce payments
Create a batch of commerce payments
Commerce Payments APIBatch1234
Create a batch of companies
Create a batch of companies
Companies APIBatch123456
Create a batch of contacts
Create a batch of contacts
Contacts APIBatch1234567
Create a batch of courses
Create a batch of objects
Courses API
Create a batch of deals
Create multiple deals in a single request.
Deals API
Create a batch of discounts
Create a batch of discounts
Discounts APIBatch1234567891011
Create a batch of fees
Create a batch of fees
Fees APIBatch12345678910111213
Create a batch of goal targets
Create multiple goal targets in a single batch operation.
Goals APIv3 [legacy]
Create a batch of invoices
Create a batch of invoices
Invoices API
Create a batch of leads
Create a batch of leads
Leads APIBatch1234567891011121314
Create a batch of line items
Create a batch of line items
Line Items APIBatch123456789101112131415
Create a batch of listings
Create multiple listings in a single request.
Listings API
Create a batch of objects
Create a batch of objects
Objects APIBatch12345678910111213141516
Create a batch of orders
Create a batch of orders
Orders APIBatch1234567891011121314151617
Create a batch of products
Create a batch of products
Products APIBatch12345678910111213141516171819
Create a batch of projects
Create multiple projects in a single request.
Projects APIBatch123456789101112131415161718192021222324252627282930
Create a batch of properties
Create a batch of properties using the same rules as when creating an individual property.
Properties APIBatch12345678910111213141516171819202122232425
Create a batch of quotes
Create a batch of quotes
Quotes APIBatch1234567891011121314151617181920
Create a batch of services
Create a batch of objects
Services API
Create a batch of subscriptions
Create a batch of subscriptions
Commerce Subscriptions API
Create a batch of taxes
Create a batch of taxes
Taxes APIBatch123456789101112131415161718192021
Create a batch of tickets
Create a batch of tickets
Tickets APIBatch12345678910111213141516171819202122
Create a company
Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard companies is provided.
Companies APIBasic1234
Create a contact
Create a contact with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard contacts is provided.
Contacts APIBasic12345
Create a goal target
Create a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided.
Goals API2026-03 [latest]Basic123456789101112131415161718192021222324252627282930
Create a new card
Defines a new card that will become active on an account when this app is installed.
CRM Cards APIV3Cards
Create a new card
Defines a new card that will become active on an account when this app is installed.
CRM Cards API2026-03Basic123456
Create an association between two CRM objects.
Establish the specified association between two CRM objects.
Appointments API
Create a pipeline
Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.
Pipelines APIPipelines
Create a pipeline stage
Create a new stage associated with the pipeline identified by `{pipelineId}`. The entire stage object, including its unique ID, will be returned in the response.
Pipelines APIPipeline Stages
Create a property
Create and return a copy of a new property for the specified object type.
Properties APICore12
Create a property group
Create and return a copy of a new property group.
Properties APIGroups
Create Default
Create the default (most generic) association type between two object types
Flexible Associations V4 APIAssociations
Create Default Associations
Create the default (most generic) association type between two object types
Flexible Associations V4 APIBatch12
Create goal targets
Create multiple goal targets in a single batch operation.
Goals API2026-03 [latest]Batch123456789101112131415161718192021222324252627282930313233
Create List
Create a new list with the provided object list definition.
Lists API
Create multiple associations between specified object types in a batch operation.
Associate all pairs of objects identified in the request body.
Associations V3 APIBatch
Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places
Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places
Deal Splits APIBatch12345678910
Create or update a batch of appointments by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Appointments API
Create or update a batch of carts by unique property values
Create and update a batch of carts by a unique property. Carts that don't exist will be created, while existing carts will be updated.
Carts API
Create or update a batch of commerce payments by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Commerce Payments API
Create or update a batch of companies by unique property values
Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.
Companies API
Create or update a batch of contacts
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Contacts API
Create or update a batch of courses by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Courses API
Create or update a batch of deals by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Deals API
Create or update a batch of discounts by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Discounts API
Create or update a batch of fees by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Fees API
Create or update a batch of goal targets by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Goals APIv3 [legacy]
Create or update a batch of invoices by unique property values
Create or update a batch of invoices by unique property values
Invoices API
Create or update a batch of line items by unique property values
Create or update a batch of line items by unique property values
Line Items API
Create or update a batch of listings by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Listings API
Create or update a batch of objects by unique property values
Create or update a batch of objects by unique property values
Objects API
Create or update a batch of orders by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Orders API
Create or update a batch of products by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Products API
Create or update a batch of projects
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Projects APIBatch123456789101112131415161718192021222324252627282930
Create or update a batch of quotes by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Quotes API
Create or update a batch of services by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Services API
Create or update a batch of subscriptions by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Commerce Subscriptions API
Create or update a batch of taxes by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Taxes API
Create or update a batch of tickets by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Tickets API
Delete
Batch delete associations for objects
Flexible Associations V4 APIBatch12
Delete
deletes all associations between two records.
Flexible Associations V4 APIAssociations
Deletes a folder
Deletes the folder with the given Id.
Lists API
Delete a card
Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.
CRM Cards APIV3Cards
Delete a card
Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.
CRM Cards API2026-03Basic123456
Delete a goal target
Delete a goal target by `{goalTargetId}` to the recycling bin.
Goals API2026-03 [latest]Basic123456789101112131415161718192021222324252627282930
Delete a goal target by ID
Delete a goal target by `{goalTargetId}` to the recycling bin.
Goals APIv3 [legacy]
Delete a List
Delete a list by **ILS list ID**. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored.
Lists API
Delete All Records from a List
Remove **all** of the records from a list. ***Note:*** *The list is not deleted.* This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
Lists APIMemberships
Delete an account flag state
Delete an account flag state
Feature Flags APIfeature-flagsv3{appId}flags{flagName}portals{portalId}
Delete an app's feature flag
Delete an app's feature flag
Feature Flags APIfeature-flagsv3{appId}flags{flagName}
Delete a pipeline
Delete the pipeline identified by `{pipelineId}`.
Pipelines APIPipelines
Delete a pipeline stage
Delete the pipeline stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`.
Pipelines APIPipeline Stages
delete-/crm/associations/v4/{from Object Type}/{to Object Type}/labels/{association Type Id} remove
delete-/crm/associations/v4/{from Object Type}/{to Object Type}/labels/{association Type Id} remove
Associations V4 Schema API
delete-/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}_/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}
delete-/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}_/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}
Goals API2026-03 [latest]Basic123456789101112131415161718192021222324252627282930
delete-/crm-object-schemas/v3/schemas/{object Type} archive
delete-/crm-object-schemas/v3/schemas/{object Type} archive
Schemas APICore123
delete-/crm-object-schemas/v3/schemas/{object Type}/associations/{association Identifier} archive Association
delete-/crm-object-schemas/v3/schemas/{object Type}/associations/{association Identifier} archive Association
Schemas APICore123
Delete goal targets
Archive multiple goal targets in a single batch operation using their IDs.
Goals API2026-03 [latest]Batch123456789101112131415161718192021222324252627282930313233
Delete Specific Labels
Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects
Flexible Associations V4 APIBatch12
Fetch List by ID
Fetch a single list by **ILS list ID**.
Lists API
Fetch List by Name
Fetch a single list by list name and object type.
Lists API
Fetch List Memberships Ordered by Added to List Date
Fetch the memberships of a list in order sorted by the time the records were added to the list. The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided.
Lists API
Fetch List Memberships Ordered by ID
Fetch the memberships of a list in order sorted by the `recordId` of the records in the list. The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided.
Lists APIMemberships
Fetch Multiple Lists
Fetch multiple lists in a single request by **ILS list ID**. The response will include the definitions of all lists that exist for the `listIds` provided.
Lists API
Fetch object type enablement status
For all object types supporting enablement, returns whether they're enabled or disabled
Objects Library APICrm_Public_Object_Library
GDPR-delete an object
Fully purge an object type and any GDPR related data
Appointments API
Get a card.
Returns the definition for a card with the given ID.
CRM Cards APIV3Cards
Get a card.
Returns the definition for a card with the given ID.
CRM Cards API2026-03Basic123456
Get active imports
Returns a paged list of active imports for this account.
Imports APICore1
Get all cards
Returns a list of cards for a given app.
CRM Cards APIV3Cards
Get all cards
Returns a list of cards for a given app.
CRM Cards API2026-03Basic123456
Get a page of goal targets
Read a page of goal targets. Control what is returned via the `properties` query param.
Goals APIv3 [legacy]Basic1234567891011121314151617181920212223242526272829
get-/crm/associations/v4/definitions/configurations/all get All
get-/crm/associations/v4/definitions/configurations/all get All
Associations V4 Schema API
get-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type} get All Between Two Object Types
get-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type} get All Between Two Object Types
Associations V4 Schema API
get-/crm/associations/v4/{from Object Type}/{to Object Type}/labels get All
get-/crm/associations/v4/{from Object Type}/{to Object Type}/labels get All
Associations V4 Schema API
get-/crm-object-schemas/v3/schemas get All
get-/crm-object-schemas/v3/schemas get All
Schemas APICore123
get-/crm-object-schemas/v3/schemas/{object Type} get By Id
get-/crm-object-schemas/v3/schemas/{object Type} get By Id
Schemas APICore123
get-/crm/v3/associations/{from Object Type}/{to Object Type}/types get All
List all the valid association types available between two object types
Associations V3 Schema APITypes
get-/crm/v3/objects/partner clients
Retrieve all partner clients, using query parameters to specify the information that gets returned.
Partner Clients APIBasic12345678910111213141516171819202122
get-/crm/v3/objects/partner clients/{partner Client Id}
Retrieve a partner client by its ID (`partnerClientId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.
Partner Clients APIBasic12345678910111213141516171819202122
Get lists record is member of
For given record provide lists this record is member of.
Lists API
Get sample card detail response
Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.
CRM Cards APIV3SampleResponse
Get sample card detail response
Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.
CRM Cards API2026-03Basic123456
Get the information on any import
A complete summary of an import record, including any updates.
Imports APICore1
Get the status of the export including the URL to download the file
Get the status of the export including the URL to download the file
Exports APIPublic_Exports
Is object type is enabled
Fetch whether object type is enabled
Objects Library APICrm_Public_Object_Library
List
List all associations of an object by object type. Limit 500 per call.
Flexible Associations V4 APIAssociations
List
Read a page of carts. Control what is returned via the `properties` query param.
Carts APIBasic1
List
Read a page of line items. Control what is returned via the `properties` query param.
Line Items APIBasic12345678910111213
List
Read a page of orders. Control what is returned via the `properties` query param.
Orders APIBasic123456789101112131415
List
Read a page of payments. Control what is returned via the `properties` query param.
Payments APIBasic12345678910111213141516
List
Read a page of products. Control what is returned via the `properties` query param.
Products APIBasic1234567891011121314151617
List
Read a page of quotes. Control what is returned via the `properties` query param.
Quotes APIBasic123456789101112131415161718
List
Read a page of taxes. Control what is returned via the `properties` query param.
Taxes APIBasic12345678910111213141516171819
List
Read a page of tickets. Control what is returned via the `properties` query param.
Tickets APIBasic1234567891011121314151617181920
List
Read a page of invoices. Control what is returned via the `properties` query param.
Invoices APIBasic123456789101112131415161718192021
List
Read a page of courses. Control what is returned via the `properties` query param.
Courses API
List
Read a page of appointments. Control what is returned via the `properties` query param.
Appointments API
List
Read a page of commerce payments. Control what is returned via the `properties` query param.
Commerce Payments APIBasic12
List
Read a page of listings. Control what is returned via the `properties` query param.
Listings API
List
Read an Object identified by `{listingId}`. `{listingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Listings API
List
Read a page of services. Control what is returned via the `properties` query param.
Services API
List
Read a page of projects. Control what is returned via the `properties` query param.
Projects APIBasic123456789101112131415161718192021222324252627
List
Read a page of partner services. Control what is returned via the `properties` query param.
Partner Services APIBasic12345678910111213141516171819202122232425262728
List
Read a page of subscriptions. Control what is returned via the `properties` query param.
Commerce Subscriptions APIBasic123
List
Read a page of objects. Control what is returned via the `properties` query param.
Objects APIBasic1234567891011121314
List
Read a page of deals. Control what is returned via the `properties` query param.
Deals API
List
Read a page of discounts. Control what is returned via the `properties` query param.
Discounts APIBasic123456789
List
Read a page of feedback submissions. Control what is returned via the `properties` query param.
Feedback Submissions APIBasic12345678910
List
Read a page of fees. Control what is returned via the `properties` query param.
Fees APIBasic1234567891011
List
Read a page of leads. Control what is returned via the `properties` query param.
Leads APIBasic123456789101112
List associations of a partner client by type
List associations of a partner client by type
Partner Clients API
List associations of a partner service by type
List associations of a partner service by type
Partner Services APIAssociations1
Merge objects
Merge two object types together
Appointments API
Merge two companies
Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).
Companies API
Merge two contacts
Merge two contact records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).
Contacts API
Merge two deals with same type
Combine two deals of the same type into a single deal.
Deals API
Merge two objects with same type
Merge two objects with same type
Custom Objects API
Merge two projects
Merge two project records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).
Projects APIPublic_Object12345678910111213
Merge two tickets
Merge two tickets
Tickets APIPublic_Object123456789101112
Moves a folder
This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given.
Lists API
Moves a list to a given folder
Given a list and a folder, the list will be moved to that folder.
Lists API
patch-/crm-object-schemas/v3/schemas/{object Type} update
patch-/crm-object-schemas/v3/schemas/{object Type} update
Schemas APICore123
patch-/crm/v3/objects/partner clients/{partner Client Id}
Update a partner client by ID (`partnerClientId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Partner Clients APIBasic12345678910111213141516171819202122
Perform a partial update of the pipeline identified by pipelineId.
Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response.
Pipelines APIPipelines
Perform a search for goal targets based on various filters and criteria.
Perform a search for goal targets based on various filters and criteria.
Goals APIv3 [legacy]Search123456789101112131415161718192021222324252627
Permanently delete a contact (GDPR-compliant)
Permanently delete a contact and all associated content to follow GDPR. Use optional property `idProperty` set to `email` to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. Learn more about [permanently deleting contacts](https://knowledge.hubspot.com/privacy-and-consent/how-do-i-perform-a-gdpr-delete-in-hubspot).
Contacts API
post-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type}/batch/create batch Create
post-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type}/batch/create batch Create
Associations V4 Schema API
post-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type}/batch/purge batch Remove
post-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type}/batch/purge batch Remove
Associations V4 Schema API
post-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type}/batch/update batch Update
post-/crm/associations/v4/definitions/configurations/{from Object Type}/{to Object Type}/batch/update batch Update
Associations V4 Schema API
post-/crm/associations/v4/{from Object Type}/{to Object Type}/labels create
post-/crm/associations/v4/{from Object Type}/{to Object Type}/labels create
Associations V4 Schema API
post-/crm/extensions/cards-dev/2026-03/{app Id}/views/migrate_/crm/v3/extensions/cards-dev/{app Id}/views/migrate
**How to use the Migrate CRM card views endpoint:** `POST /crm/extensions/cards-dev/2026-03/{appId}/views/migrate` - Authentication: Developer API key (`developer_hapikey`) - Path parameter: `appId` (integer) — your app ID **Request body (JSON):** | Field | Type | Required | | --- | --- | --- | | `legacyCrmCardId` | integer (int64) | Yes | | `appCardId` | integer (int64) | Yes | | `helpdeskAppCardId` | integer (int64) | No | **Example** **request**: ``` { "legacyCrmCardId": 123456, "appCardId": 789012, "helpdeskAppCardId": 111213} ``` **Response (200):** Returns an object with a `message` string confirming the migration. This endpoint migrates views from a legacy CRM card to a newer app card. You provide the IDs of both the legacy and new cards. [Migrate CRM card views](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/migrate-crm-card)
CRM Cards API2026-03Migrate
post-/crm-object-schemas/v3/schemas create
post-/crm-object-schemas/v3/schemas create
Schemas APICore123
post-/crm-object-schemas/v3/schemas/{object Type}/associations create Association
post-/crm-object-schemas/v3/schemas/{object Type}/associations create Association
Schemas APICore123
post-/crm/v3/objects/discounts/search
post-/crm/v3/objects/discounts/search
Discounts APISearch1234567
post-/crm/v3/objects/fees/search
post-/crm/v3/objects/fees/search
Fees APISearch123456789
post-/crm/v3/objects/invoices/search do Search
post-/crm/v3/objects/invoices/search do Search
Invoices APISearch12345678910111213141516171819
post-/crm/v3/objects/leads/search do Search
post-/crm/v3/objects/leads/search do Search
Leads APISearch12345678910
post-/crm/v3/objects/line items/search do Search
post-/crm/v3/objects/line items/search do Search
Line Items APISearch1234567891011
post-/crm/v3/objects/partner clients/batch/read
Retrieve a batch of partner clients by ID (`partnerClientId`) or unique property value (`idProperty`).
Partner Clients APIBatch123456789101112131415161718192021222324
post-/crm/v3/objects/partner clients/batch/update
Update a batch of partner clients by ID (`partnerClientId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Partner Clients APIBatch123456789101112131415161718192021222324
post-/crm/v3/objects/partner clients/search
Search for partner clients by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).
Partner Clients APISearch1234567891011121314151617181920
post-/crm/v3/objects/partner services/search
post-/crm/v3/objects/partner services/search
Partner Services APISearch1234567891011121314151617181920212223242526
post-/crm/v3/objects/payments/search
post-/crm/v3/objects/payments/search
Payments APISearch1234567891011121314
post-/crm/v3/objects/products/search do Search
post-/crm/v3/objects/products/search do Search
Products APISearch123456789101112131415
post-/crm/v3/objects/quotes/search do Search
post-/crm/v3/objects/quotes/search do Search
Quotes APISearch12345678910111213141516
post-/crm/v3/objects/subscriptions/search
post-/crm/v3/objects/subscriptions/search
Commerce Subscriptions APISearch12
post-/crm/v3/objects/taxes/search do Search
post-/crm/v3/objects/taxes/search do Search
Taxes APISearch1234567891011121314151617
put-/crm/associations/v4/{from Object Type}/{to Object Type}/labels update
put-/crm/associations/v4/{from Object Type}/{to Object Type}/labels update
Associations V4 Schema API
put-/crm/objects/2026-03/{from Object Type}/{from Object Id}/associations/default/{to Object Type}/{to Object Id}_/crm/objects/2026-03/{from Object Type}/{from Object Id}/associations/default/{to Object Type}/{to Object Id}
put-/crm/objects/2026-03/{from Object Type}/{from Object Id}/associations/default/{to Object Type}/{to Object Id}_/crm/objects/2026-03/{from Object Type}/{from Object Id}/associations/default/{to Object Type}/{to Object Id}
Goals API2026-03 [latest]Batch123456789101112131415161718192021222324252627282930313233
put-/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}_/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}
put-/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}_/crm/objects/2026-03/{object Type}/{object Id}/associations/{to Object Type}/{to Object Id}
Goals API2026-03 [latest]Basic123456789101112131415161718192021222324252627282930
Read
Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored.
Flexible Associations V4 APIBatch12
Read
Read an Object identified by `{cartId}`. `{cartId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Carts APIBasic1
Read
Read an Object identified by `{lineItemId}`. `{lineItemId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Line Items APIBasic12345678910111213
Read
Read an Object identified by `{orderId}`. `{orderId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Orders APIBasic123456789101112131415
Read
Read an Object identified by `{paymentsId}`. `{paymentsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Payments APIBasic12345678910111213141516
Read
Read an Object identified by `{productId}`. `{productId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Products APIBasic1234567891011121314151617
Read
Read an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Quotes APIBasic123456789101112131415161718
Read
Read an Object identified by `{taxId}`. `{taxId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Taxes APIBasic12345678910111213141516171819
Read
Read an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Tickets APIBasic1234567891011121314151617181920
Read
Read an Object identified by `{invoiceId}`. `{invoiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Invoices APIBasic123456789101112131415161718192021
Read
Read an Object identified by `{courseId}`. `{courseId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Courses API
Read
Read an Object identified by `{appointmentId}`. `{appointmentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Appointments API
Read
Read a payment identified by its ID. Include an optional `properties` query parameter to control the properties that are returned.
Commerce Payments APIBasic12
Read
Read an Object identified by `{serviceId}`. `{serviceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Services API
Read
Read an Object identified by `{projectId}`. `{projectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Projects APIBasic123456789101112131415161718192021222324252627
Read
Read an Object identified by `{partnerServiceId}`. `{partnerServiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Partner Services APIBasic12345678910111213141516171819202122232425262728
Read
Read an Object identified by `{goalTargetId}`. `{goalTargetId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Goals APIv3 [legacy]Basic1234567891011121314151617181920212223242526272829
Read
Read an Object identified by `{subscriptionId}`. `{subscriptionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Commerce Subscriptions APIBasic123
Read
Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Objects APIBasic1234567891011121314
Read
Read an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Deals API
Read
Read an Object identified by `{discountId}`. `{discountId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Discounts APIBasic123456789
Read
Read an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Feedback Submissions APIBasic12345678910
Read
Read an Object identified by `{feeId}`. `{feeId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Fees APIBasic1234567891011
Read
Read an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Leads APIBasic123456789101112
Read a batch of appointments by internal ID, or unique property values
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Appointments API
Read a batch of carts by internal ID, or unique property values
Read a batch of carts by internal ID, or unique property values
Carts APIBatch123
Read a batch of commerce payments by internal ID, or unique property values
Read a batch of commerce payments by internal ID, or unique property values
Commerce Payments APIBatch1234
Read a batch of courses by internal ID, or unique property values
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Courses API
Read a batch of deals by internal ID, or unique property values
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Deals API
Read a batch of deal split objects by their associated deal object internal ID
Read a batch of deal split objects by their associated deal object internal ID
Deal Splits APIBatch12345678910
Read a batch of discounts by internal ID, or unique property values
Read a batch of discounts by internal ID, or unique property values
Discounts APIBatch1234567891011
Read a batch of feedback submissions by internal ID, or unique property values
Read a batch of feedback submissions by internal ID, or unique property values
Feedback Submissions APIBatch123456789101112
Read a batch of fees by internal ID, or unique property values
Read a batch of fees by internal ID, or unique property values
Fees APIBatch12345678910111213
Read a batch of goal targets by internal ID, or unique property values
Read a batch of goal targets by internal ID, or unique property values
Goals APIv3 [legacy]Batch1234567891011121314151617181920212223242526272829303132
Read a batch of invoices by internal ID, or unique property values
Read a batch of invoices by internal ID, or unique property values
Invoices APIBatch1234567891011121314151617181920212223
Read a batch of leads by internal ID, or unique property values
Read a batch of leads by internal ID, or unique property values
Leads APIBatch1234567891011121314
Read a batch of line items by internal ID, or unique property values
Read a batch of line items by internal ID, or unique property values
Line Items APIBatch123456789101112131415
Read a batch of listings by internal ID, or unique property values
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Listings API
Read a batch of objects by internal ID, or unique property values
Read a batch of objects by internal ID, or unique property values
Objects APIBatch12345678910111213141516
Read a batch of orders by internal ID, or unique property values
Read a batch of orders by internal ID, or unique property values
Orders APIBatch1234567891011121314151617
Read a batch of partner services by internal ID, or unique property values
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Partner Services APIBatch12345678910111213141516171819202122232425262728293031
Read a batch of payments by internal ID, or unique property values
Read a batch of payments by internal ID, or unique property values
Payments APIBatch123456789101112131415161718
Read a batch of products by internal ID, or unique property values
Read a batch of products by internal ID, or unique property values
Products APIBatch12345678910111213141516171819
Read a batch of projects
Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.
Projects APIBatch123456789101112131415161718192021222324252627282930
Read a batch of properties
Read a provided list of properties.
Properties APIBatch12345678910111213141516171819202122232425
Read a batch of quotes by internal ID, or unique property values
Read a batch of quotes by internal ID, or unique property values
Quotes APIBatch1234567891011121314151617181920
Read a batch of services by internal ID, or unique property values
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Services API
Read a batch of subscriptions by internal ID, or unique property values
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Commerce Subscriptions API
Read a batch of taxes by internal ID, or unique property values
Read a batch of taxes by internal ID, or unique property values
Taxes APIBatch123456789101112131415161718192021
Read a batch of tickets by internal ID, or unique property values
Read a batch of tickets by internal ID, or unique property values
Tickets APIBatch12345678910111213141516171819202122
Read all properties
Read all existing properties for the specified object type and HubSpot account.
Properties APICore12
Read all property groups
Read all existing property groups for the specified object type and HubSpot account.
Properties APIGroups
Read all property validation rules for an object
Read all properties with validation rules for a given object.
Property Validations APIPublic_Property_Validations
Read a property
Read a property identified by {propertyName}.
Properties APICore12
Read a property group
Read a property group identified by {groupName}.
Properties APIGroups
Read association label limits
Returns limits and usage for custom association labels
Limits Tracking APILimits
Read calculation property limits
Returns overall limit and per object usage for calculated properties
Limits Tracking APILimits
Read custom object limits
Returns limits and usage for custom object schemas
Limits Tracking APILimits
Read custom property limits
Returns limits and usage per object for custom properties
Limits Tracking APILimits
Read pipeline limits
Returns limits and usage per object for pipelines
Limits Tracking APILimits
Read record association limits
Returns objects with records approaching or at association limits
Limits Tracking APILimits
Read record association limits between two objects
Returns records approaching or at association limits between two objects
Limits Tracking APILimits
Read record association limits from an object
Returns objects for which the from object has records approaching or at association limits
Limits Tracking APILimits
Read record limits
Returns limits and usage per object for records
Limits Tracking APILimits
Read validation rules for a property
Read a property's validation rules identified by {propertyName}.
Property Validations APIPublic_Property_Validations
Remove an association between two CRM objects.
Delete the specified association between two CRM objects.
Appointments API
Remove an association between two partner clients
Remove an association between two partner clients
Partner Clients API
Remove an association between two partner services
Remove an association between two partner services
Partner Services APIAssociations1
Remove Records from a List
Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
Lists APIMemberships
Rename a folder
Renames the given folderId with a new name.
Lists API
Replace a pipeline
Replace all the properties of an existing pipeline with the values provided. This will overwrite any existing pipeline stages. The updated pipeline will be returned in the response.
Pipelines APIPipelines
Replace a pipeline stage
Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.
Pipelines APIPipeline Stages
Report
Requests a report of all objects in the portal which have a high usage of associations
Associations V4 API
Restore a List
Restore a previously deleted list by **ILS list ID**. Deleted lists are eligible to be restored up-to 90-days after the list has been deleted.
Lists API
Retrieves a folder.
Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder.
Lists API
Retrieve a batch of companies
Retrieve a batch of companies
Companies APIBatch123456
Retrieve a batch of contacts
Retrieve a batch of contacts
Contacts APIBatch1234567
Retrieve accounts with a set flag state
Retrieve accounts with a set flag state
Feature Flags APIfeature-flagsv3{appId}flags{flagName}portals
Retrieve account flag state
Retrieve account flag state
Feature Flags APIfeature-flagsv3{appId}flags{flagName}portals{portalId}
Retrieve a company
Read an Object identified by `{companyId}`. `{companyId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Companies APIBasic1234
Retrieve a contact
Read an Object identified by `{contactId}`. `{contactId}` refers to the internal object ID. Control what is returned via the `properties` query param.
Contacts APIBasic12345
Retrieve a goal target
Retrieve a goal target by its ID. You can specify what is returned using the `properties` query parameter.
Goals API2026-03 [latest]Basic123456789101112131415161718192021222324252627282930
Retrieve a list of all custom forecast types available.
Retrieve a list of all custom forecast types available (excludes the default forecast type of 0).
Forecasts Read APIForecast Types
Retrieve all pipelines
Return all pipelines for the object type specified by `{objectType}`.
Pipelines APIPipelines
Retrieve an app's feature flags
Retrieve an app's feature flags
Feature Flags APIfeature-flagsv3{appId}flags{flagName}
Retrieve a paginated list of owners available in the account.
Retrieve a paginated list of owners available in the account.
Owners APIOwners
Retrieve a paginated list of owners available in the account.
Retrieve a paginated list of owners available in the account.
Owners APIOwners
Retrieve a reverse chronological list of all changes made to a specific pipeline stage.
Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`.
Pipelines API
Retrieve associated object IDs for a given object type, with optional inclusion of fully associated objects.
Retrieve associated object IDs for a given object type.
Appointments API
Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted.
Retrieve a specific validation rule for a property identified by its name and rule type.
Property Validations API
Retrieve companies
Read a page of companies. Control what is returned via the `properties` query param.
Companies APIBasic1234
Retrieve contacts
Read a page of contacts. Control what is returned via the `properties` query param.
Contacts APIBasic12345
Retrieve details for a specific custom forecast type using its unique identifier.
Retrieve details for a specific custom forecast type using its unique identifier.
Forecasts Read APIForecast Types
Retrieve details of a specific export by its unique ID.
Retrieve detailed information about a specific CRM export, including its current state and properties.
Exports API
Retrieve errors for a specific import
Retrieve errors for a specific import
Imports APIPublic_Imports
Retrieve goal targets
Read a page of goal targets. Control what is returned via the `properties` query param.
Goals API2026-03 [latest]Basic123456789101112131415161718192021222324252627282930
Retrieve goal targets
Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property.
Goals API2026-03 [latest]Batch123456789101112131415161718192021222324252627282930313233
Retrieve multiple associations between specified object types in a batch operation.
Get the IDs of all `{toObjectType}` objects associated with those specified in the request body.
Associations V3 APIBatch
Retrieve the conversion details for a list
Retrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted.
Lists API
Return all stages of a pipeline
Return all the stages associated with the pipeline identified by `{pipelineId}`.
Pipelines APIPipeline Stages
Return an audit of all changes to the pipeline
Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`.
Pipelines APIPipeline Audits
Return a pipeline by ID
Return a single pipeline object identified by its unique `{pipelineId}`.
Pipelines APIPipelines
Return a pipeline stage by ID
Return the stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`.
Pipelines APIPipeline Stages
Schedule or update the conversion of a list to static
Schedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity.
Lists API
Search across objects
Fetch objects via a search query
Services API
Search for appointments using filters, sorting, and pagination to retrieve specific records.
Search for appointments based on specified criteria.
Appointments API
Search for carts using specified criteria and return matching results.
Search for carts using specified criteria and return matching results.
Carts APISearch
Search for commerce payments using specified criteria.
Search for commerce payments using specified criteria.
Commerce Payments APISearch1
Search for companies
Search for companies
Companies APISearch123
Search for contacts
Search for contacts
Contacts APISearch1234
Search for CRM objects of a specified type.
Search for CRM objects of a specified type.
Objects APISearch123456789101112
Search for deals using various filters and criteria to retrieve specific records.
Search for deals using specified criteria and filters.
Deals API
Search for feedback submissions using specified criteria.
Search for feedback submissions using specified criteria.
Feedback Submissions APISearch12345678
Search for goal targets
Search for goal targets using specified criteria.
Goals API2026-03 [latest]Search12345678910111213141516171819202122232425262728
Search for listings using various criteria and filters.
Execute a search query to find listings based on specified filters and properties.
Listings API
Search for objects
Fetch objects using a search query
Courses API
Search for orders in the CRM using various filters and sorting options to retrieve specific order data.
Search for orders in the CRM using various filters and sorting options to retrieve specific order data.
Orders APISearch12345678910111213
Search for projects
Search for projects by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).
Projects APISearch12345678910111213141516171819202122232425
Search for tickets
Search for tickets
Tickets APISearch123456789101112131415161718
Search Lists
Search lists by list name or page through all lists by providing an empty `query` value.
Lists APILists
Set an account flag state
Set an account flag state
Feature Flags APIfeature-flagsv3{appId}flags{flagName}portals{portalId}
Set an app's feature flag
Set an app's feature flag
Feature Flags APIfeature-flagsv3{appId}flags{flagName}
Start an export
Begins exporting CRM data for the portal as specified in the request body
Exports APICore
Translate Legacy List Id to Modern List Id
This API allows translation of legacy list id to list id. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.
Lists API
Translate Legacy List Id to Modern List Id in Batch
This API allows translation of a batch of legacy list id's to list id's. This allows for a maximum of 10,000 id's. This is a temporary API allowed for mapping old id's to new id's and will expire on May 30th, 2025.
Lists API
Update
Perform a partial update of an Object identified by `{cartId}`. `{cartId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Carts APIBasic1
Update
Perform a partial update of an Object identified by `{commercePaymentId}`. `{commercePaymentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Commerce Payments APIBasic12
Update
Perform a partial update of an Object identified by `{productId}`. `{productId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Products APIBasic1234567891011121314151617
Update
Perform a partial update of an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Quotes APIBasic123456789101112131415161718
Update
Perform a partial update of an Object identified by `{taxId}`. `{taxId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Taxes APIBasic12345678910111213141516171819
Update
Perform a partial update of an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Tickets APIBasic1234567891011121314151617181920
Update
Perform a partial update of an Object identified by `{invoiceId}`. `{invoiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Invoices API
Update
Perform a partial update of an Object identified by `{courseId}`or optionally a unique property value as specified by the `idProperty` query param. `{courseId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Courses API
Update
Perform a partial update of an Object identified by `{appointmentId}`or optionally a unique property value as specified by the `idProperty` query param. `{appointmentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Appointments API
Update
Perform a partial update of an Object identified by `{listingId}`or optionally a unique property value as specified by the `idProperty` query param. `{listingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Listings API
Update
Perform a partial update of an Object identified by `{serviceId}`or optionally a unique property value as specified by the `idProperty` query param. `{serviceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Services API
Update
Perform a partial update of an Object identified by `{projectId}`or optionally a unique property value as specified by the `idProperty` query param. `{projectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Projects APIBasic123456789101112131415161718192021222324252627
Update
Perform a partial update of an Object identified by `{subscriptionId}`or optionally a unique property value as specified by the `idProperty` query param. `{subscriptionId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Commerce Subscriptions API
Update
Perform a partial update of an Object identified by `{partnerServiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{partnerServiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Partner Services APIBasic12345678910111213141516171819202122232425262728
Update
Perform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Goals APIv3 [legacy]
Update
Perform a partial update of an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Objects APIBasic1234567891011121314
Update
Perform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Deals API
Update
Perform a partial update of an Object identified by `{discountId}`. `{discountId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Discounts APIBasic123456789
Update
Perform a partial update of an Object identified by `{feeId}`. `{feeId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Fees APIBasic1234567891011
Update
Perform a partial update of an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Leads APIBasic123456789101112
Update
Perform a partial update of an Object identified by `{lineItemId}`. `{lineItemId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Line Items APIBasic12345678910111213
Update
Perform a partial update of an Object identified by `{orderId}`. `{orderId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Orders APIBasic123456789101112131415
Update a batch of appointments by internal ID, or unique property values
Update multiple appointments using their internal IDs or unique property values.
Appointments API
Update a batch of carts by internal ID, or unique property values
Update a batch of carts by internal ID, or unique property values
Carts APIBatch123
Update a batch of commerce payments by internal ID, or unique property values
Update a batch of commerce payments by internal ID, or unique property values
Commerce Payments APIBatch1234
Update a batch of companies
Update a batch of companies
Companies APIBatch123456
Update a batch of contacts
Update a batch of contacts
Contacts APIBatch1234567
Update a batch of courses by internal ID, or unique property values
Update a batch of objects
Courses API
Update a batch of deals by internal ID, or unique property values
Update multiple deals using their internal IDs or unique property values.
Deals API
Update a batch of discounts by internal ID, or unique property values
Update a batch of discounts by internal ID, or unique property values
Discounts APIBatch1234567891011
Update a batch of fees by internal ID, or unique property values
Update a batch of fees by internal ID, or unique property values
Fees APIBatch12345678910111213
Update a batch of goal targets by internal ID, or unique property values
Update multiple goal targets in a single batch operation using their internal IDs or unique property values.
Goals APIv3 [legacy]
Update a batch of invoices by internal ID, or unique property values
Update a batch of invoices by internal ID, or unique property values
Invoices API
Update a batch of leads by internal ID, or unique property values
Update a batch of leads by internal ID, or unique property values
Leads APIBatch1234567891011121314
Update a batch of line items by internal ID, or unique property values
Update a batch of line items by internal ID, or unique property values
Line Items APIBatch123456789101112131415
Update a batch of listings by internal ID, or unique property values
Update multiple listings using their internal IDs or unique property values.
Listings API
Update a batch of objects by internal ID, or unique property values
Update a batch of objects by internal ID, or unique property values
Objects APIBatch12345678910111213141516
Update a batch of orders by internal ID, or unique property values
Update a batch of orders by internal ID, or unique property values
Orders APIBatch1234567891011121314151617
Update a batch of partner services by internal ID, or unique property values
Update a batch of partner services by internal ID, or unique property values
Partner Services APIBatch12345678910111213141516171819202122232425262728293031
Update a batch of products by internal ID, or unique property values
Update a batch of products by internal ID, or unique property values
Products APIBatch12345678910111213141516171819
Update a batch of projects
Update multiple projects using their internal IDs or unique property values.
Projects APIBatch123456789101112131415161718192021222324252627282930
Update a batch of quotes by internal ID, or unique property values
Update a batch of quotes by internal ID, or unique property values
Quotes APIBatch1234567891011121314151617181920
Update a batch of services by internal ID, or unique property values
Update a batch of objects
Services API
Update a batch of subscriptions by internal ID, or unique property values
Update a batch of subscriptions by internal ID, or unique property values
Commerce Subscriptions API
Update a batch of taxes by internal ID, or unique property values
Update a batch of taxes by internal ID, or unique property values
Taxes APIBatch123456789101112131415161718192021
Update a batch of tickets by internal ID, or unique property values
Update a batch of tickets by internal ID, or unique property values
Tickets APIBatch12345678910111213141516171819202122
Update a card
Update a card definition with new details.
CRM Cards APIV3Cards
Update a card
Update a card definition with new details.
CRM Cards API2026-03Basic123456
Update a company
Perform a partial update of an Object identified by `{companyId}`. `{companyId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Companies APIBasic1234
Update a contact
Perform a partial update of an Object identified by `{contactId}`. `{contactId}` refers to the internal object ID. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Contacts APIBasic12345
Update a goal target
Perform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Goals API2026-03 [latest]Basic123456789101112131415161718192021222324252627282930
Update a property
Perform a partial update of a property identified by {propertyName}. Provided fields will be overwritten.
Properties APICore12
Update a property group
Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.
Properties APIGroups
Update a validation rule for a specific property and rule type, allowing customization of property value constraints.
Update a specific validation rule for a property identified by its name and rule type.
Property Validations API
Update goal targets
Update multiple goal targets in a single batch operation using their internal IDs or unique property values.
Goals API2026-03 [latest]Batch123456789101112131415161718192021222324252627282930313233
Update List Filter Definition
Update the filter branch definition of a `DYNAMIC` list. Once updated, the list memberships will be re-evaluated and updated to match the new definition.
Lists API
Update List Name
Update the name of a list. The name must be globally unique relative to all other public lists in the portal.
Lists API
Update specific properties of an existing pipeline stage.
Perform a partial update of the pipeline stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response.
Pipelines APIPipeline Stages
Upsert goal tagets
Create and update a batch of goal targets by a unique property. Goal targets that don't exist will be created, while existing goal targets will be updated.
Goals API2026-03 [latest]Batch123456789101112131415161718192021222324252627282930313233
Delete data source
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.
File Ingestion API2026-09-beta [latest]Basic
Retrieve data source
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.
File Ingestion API2026-09-beta [latest]Basic
Archive
Move an Object identified by `{objectId}` to the recycling bin.
Objects DBV APIcrm1objects12025-09123{objectType}1{objectId}1
Archive a batch of objects by ID
Archive a batch of objects by ID
Objects DBV APIcrm1objects12025-09123{objectType}1batch123archive123
Archive a batch of properties
Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).
Properties DBV APIcrm12properties2025-091234{objectType}12batch1234archive1234
Archive a property
Move a property identified by {propertyName} to the recycling bin.
Properties DBV APIcrm12properties2025-091234{objectType}12{propertyName}
Archive a property group
Move a property group identified by {groupName} to the recycling bin.
Properties DBV APIcrm12properties2025-091234{objectType}12groups{groupName}
Create
Set association labels between two records.
Associations DBV APIcrmobjects2025-091{objectType}{objectId}associations{toObjectType}{toObjectId}
Create
Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.
Objects DBV APIcrm1objects12025-09123{objectType}1
Create
Batch create associations for objects
Associations DBV APIcrmassociations122025-0912{fromObjectType}12{toObjectType}123batch12create12
Create a batch of objects
Create a batch of objects
Objects DBV APIcrm1objects12025-09123{objectType}1batch123create123
Create a batch of properties
Create a batch of properties using the same rules as when creating an individual property.
Properties DBV APIcrm12properties2025-091234{objectType}12batch1234create1234
Create a property
Create and return a copy of a new property for the specified object type.
Properties DBV APIcrm12properties2025-091234{objectType}12
Create a property group
Create and return a copy of a new property group.
Properties DBV APIcrm12properties2025-091234{objectType}12groups
Create Default
Create the default (most generic) association type between two object types
Associations DBV APIcrmobjects2025-091{fromObjectType}{fromObjectId}associations1default{toObjectType}1{toObjectId}1
Create Default Associations
Create the default (most generic) association type between two object types
Associations DBV APIcrmassociations122025-0912{fromObjectType}12{toObjectType}123batch12associatedefault1
Delete
deletes all associations between two records.
Associations DBV APIcrmobjects2025-091{objectType}{objectId}associations{toObjectType}{toObjectId}
Delete
Batch delete associations for objects
Associations DBV APIcrmassociations122025-0912{fromObjectType}12{toObjectType}123batch12archive12
Delete Specific Labels
Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects
Associations DBV APIcrmassociations122025-0912{fromObjectType}12{toObjectType}123batch12labelsarchive1
GDPR DELETE
Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.
Associations DBV APIcrmobjects2025-091{objectType}gdpr-delete
get-/account-info/2025-09/activity/audit-logs
get-/account-info/2025-09/activity/audit-logs
Account Info DBV APIaccount-info2025-09activityaudit-logs
Get login activity for a HubSpot account.
Get login activity.
Account Info DBV APIaccount-info2025-09activitylogin
Get security activity for a HubSpot account
Get security activity
Account Info DBV APIaccount-info2025-09activitysecurity
List
List all associations of an object by object type. Limit 500 per call.
Associations DBV APIcrmobjects2025-091{objectType}{objectId}associations{toObjectType}
List
Read a page of objects. Control what is returned via the `properties` query param.
Objects DBV APIcrm1objects12025-09123{objectType}1
post-/crm/objects/2025-09/{object Type}/batch/upsert_/crm/objects/2025-09/{object Type}/batch/upsert
post-/crm/objects/2025-09/{object Type}/batch/upsert_/crm/objects/2025-09/{object Type}/batch/upsert
Objects DBV APIcrm1objects12025-09123{objectType}1batch123upsert1
post-/crm/objects/2025-09/{object Type}/merge_/crm/objects/2025-09/{object Type}/merge
post-/crm/objects/2025-09/{object Type}/merge_/crm/objects/2025-09/{object Type}/merge
Associations DBV APIcrmobjects2025-091{objectType}merge
post-/crm/objects/2025-09/{object Type}/search_/crm/objects/2025-09/{object Type}/search
post-/crm/objects/2025-09/{object Type}/search_/crm/objects/2025-09/{object Type}/search
Objects DBV APIcrm1objects12025-09123{objectType}1search1
Read
Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Objects DBV APIcrm1objects12025-09123{objectType}1{objectId}1
Read
Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.
Associations DBV APIcrmassociations122025-0912{fromObjectType}12{toObjectType}123batch12read1
Read a batch of objects by internal ID, or unique property values
Read a batch of objects by internal ID, or unique property values
Objects DBV APIcrm1objects12025-09123{objectType}1batch123read12
Read a batch of properties
Read a provided list of properties.
Properties DBV APIcrm12properties2025-091234{objectType}12batch1234read123
Read all properties
Read all existing properties for the specified object type and HubSpot account.
Properties DBV APIcrm12properties2025-091234{objectType}12
Read all property groups
Read all existing property groups for the specified object type and HubSpot account.
Properties DBV APIcrm12properties2025-091234{objectType}12groups
Read a property
Read a property identified by {propertyName}.
Properties DBV APIcrm12properties2025-091234{objectType}12{propertyName}
Read a property group
Read a property group identified by {groupName}.
Properties DBV APIcrm12properties2025-091234{objectType}12groups{groupName}
Report
Requests a report of all objects in the portal which have a high usage of associations
Associations DBV APIcrmassociations122025-0912usagehigh-usage-report{userId}
Retrieve account details
Retrieve account details such as the account type, time zone, currencies, and data hosting location.
Account Info DBV APIaccount-info2025-09details
Retrieve private app daily API usage
Retrieve the daily API usage for private apps in the account, along with information about usage limits.
Account Info DBV APIaccount-info2025-09api-usagedailyprivate-apps
Update
Perform a partial update of an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Objects DBV APIcrm1objects12025-09123{objectType}1{objectId}1
Update a batch of objects by internal ID, or unique property values
Update a batch of objects by internal ID, or unique property values
Objects DBV APIcrm1objects12025-09123{objectType}1batch123update12
Update a property
Perform a partial update of a property identified by {propertyName}. Provided fields will be overwritten.
Properties DBV APIcrm12properties2025-091234{objectType}12{propertyName}
Update a property group
Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.
Properties DBV APIcrm12properties2025-091234{objectType}12groups{groupName}
Archive
Move an Object identified by `{callId}` to the recycling bin.
Calls APIBasic
Archive
Move an Object identified by `{emailId}` to the recycling bin.
Email APIBasic1
Archive
Move an Object identified by `{meetingId}` to the recycling bin.
Meetings APIBasic12
Archive
Move an Object identified by `{noteId}` to the recycling bin.
Notes APIBasic123
Archive
Move an Object identified by `{postalMailId}` to the recycling bin.
Postal Mail APIBasic1234
Archive
Move an Object identified by `{taskId}` to the recycling bin.
Tasks APIBasic12345
Archive
Move an Object identified by `{communicationId}` to the recycling bin.
Communications APIBasic123456
Archive a batch of calls by ID
Archive a batch of calls by ID
Calls APIBatch
Archive a batch of communications by ID
Archive a batch of communications by ID
Communications APIBatch123456
Archive a batch of emails by ID
Archive a batch of emails by ID
Email APIBatch1
Archive a batch of meetings by ID
Archive a batch of meetings by ID
Meetings APIBatch12
Archive a batch of notes by ID
Archive a batch of notes by ID
Notes APIBatch123
Archive a batch of tasks by ID
Archive a batch of tasks by ID
Tasks APIBatch12345
Batch archive
Batch archive
Postal Mail APIBatch1234
Batch create
Batch create
Postal Mail APIBatch1234
Batch upsert
Create or update postal mails identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Postal Mail API
Create
Create a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided.
Calls APIBasic
Create
Create a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.
Email APIBasic1
Create
Create a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided.
Meetings APIBasic12
Create
Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.
Notes APIBasic123
Create
Create a postal mail with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard postal mail is provided.
Postal Mail APIBasic1234
Create
Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.
Tasks APIBasic12345
Create
Create a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided.
Communications APIBasic123456
Create a batch of calls
Create a batch of calls
Calls APIBatch
Create a batch of communications
Create a batch of communications
Communications APIBatch123456
Create a batch of emails
Create a batch of emails
Email APIBatch1
Create a batch of meetings
Create a batch of meetings
Meetings APIBatch12
Create a batch of notes
Create a batch of notes
Notes APIBatch123
Create a batch of tasks
Create a batch of tasks
Tasks APIBatch12345
Create or update a batch of calls by unique property values
Create or update a batch of calls by ID (`callId`) or unique property value (`idProperty`).
Calls API
Create or update a batch of communications by unique property values
Create and update a batch of messages by a unique property. Messages that don't exist will be created, while existing messages will be updated.
Communications API
Create or update a batch of emails by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Email API
Create or update a batch of meetings by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Meetings API
Create or update a batch of notes by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Notes API
Create or update a batch of tasks by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Tasks API
get-/crm/v3/objects/postal mail get Page
Read a page of postal mail. Control what is returned via the `properties` query param.
Postal Mail APIBasic1234
get-/crm/v3/objects/postal mail/{postal Mail Id} get By Id
Read an Object identified by `{postalMailId}`. `{postalMailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Postal Mail APIBasic1234
List
Read a page of calls. Control what is returned via the `properties` query param.
Calls APIBasic
List
Read a page of emails. Control what is returned via the `properties` query param.
Email APIBasic1
List
Read a page of meetings. Control what is returned via the `properties` query param.
Meetings APIBasic12
List
Read a page of notes. Control what is returned via the `properties` query param.
Notes APIBasic123
List
Read a page of tasks. Control what is returned via the `properties` query param.
Tasks APIBasic12345
List
Read a page of communications. Control what is returned via the `properties` query param.
Communications APIBasic123456
patch-/crm/v3/objects/postal mail/{postal Mail Id} update
Perform a partial update of an Object identified by `{postalMailId}`. `{postalMailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Postal Mail APIBasic1234
post-/crm/v3/objects/meetings/search do Search
post-/crm/v3/objects/meetings/search do Search
Meetings APISearch12
post-/crm/v3/objects/notes/search do Search
post-/crm/v3/objects/notes/search do Search
Notes APISearch123
post-/crm/v3/objects/postal mail/batch/read read
post-/crm/v3/objects/postal mail/batch/read read
Postal Mail APIBatch1234
post-/crm/v3/objects/postal mail/batch/update update
post-/crm/v3/objects/postal mail/batch/update update
Postal Mail APIBatch1234
post-/crm/v3/objects/tasks/search do Search
post-/crm/v3/objects/tasks/search do Search
Tasks APISearch12345
Read
Read an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Calls APIBasic
Read
Read an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Email APIBasic1
Read
Read an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Meetings APIBasic12
Read
Read an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Notes APIBasic123
Read
Read an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Tasks APIBasic12345
Read
Read an Object identified by `{communicationId}`. `{communicationId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Communications APIBasic123456
Read a batch of calls by internal ID, or unique property values
Read a batch of calls by internal ID, or unique property values
Calls APIBatch
Read a batch of communications by internal ID, or unique property values
Read a batch of communications by internal ID, or unique property values
Communications APIBatch123456
Read a batch of emails by internal ID, or unique property values
Read a batch of emails by internal ID, or unique property values
Email APIBatch1
Read a batch of meetings by internal ID, or unique property values
Read a batch of meetings by internal ID, or unique property values
Meetings APIBatch12
Read a batch of notes by internal ID, or unique property values
Read a batch of notes by internal ID, or unique property values
Notes APIBatch123
Read a batch of tasks by internal ID, or unique property values
Read a batch of tasks by internal ID, or unique property values
Tasks APIBatch12345
Search
Search
Postal Mail APISearch1234
Search for calls
Search for calls
Calls APISearch
Search for emails using specified criteria and filters.
Search for emails using specified criteria and filters.
Email APISearch1
Search for messages
Search for messages
Communications APISearch123456
Update
Perform a partial update of an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Calls APIBasic
Update
Perform a partial update of an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Email APIBasic1
Update
Perform a partial update of an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Meetings APIBasic12
Update
Perform a partial update of an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Notes APIBasic123
Update
Perform a partial update of an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Tasks APIBasic12345
Update
Perform a partial update of an Object identified by `{communicationId}`. `{communicationId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
Communications APIBasic123456
Update a batch of calls by internal ID, or unique property values
Update a batch of calls by internal ID, or unique property values
Calls APIBatch
Update a batch of communications by internal ID, or unique property values
Update a batch of communications by internal ID, or unique property values
Communications APIBatch123456
Update a batch of emails by internal ID, or unique property values
Update a batch of emails by internal ID, or unique property values
Email APIBatch1
Update a batch of meetings by internal ID, or unique property values
Update a batch of meetings by internal ID, or unique property values
Meetings APIBatch12
Update a batch of notes by internal ID, or unique property values
Update a batch of notes by internal ID, or unique property values
Notes APIBatch123
Update a batch of tasks by internal ID, or unique property values
Update a batch of tasks by internal ID, or unique property values
Tasks APIBatch12345
Create a property for an event definition
Add a new property to an existing custom event definition.
Custom Event Definitions APIEvent definition
Create custom event definition
Create a custom event definition.
Custom Event Definitions APIEvent definition
Delete an event definition
Delete an event definition
Custom Event Definitions APIEvent definition
Delete a property from a custom event definition
Deletes a property from an existing custom event definition.
Custom Event Definitions APIEvent definition
Event Types
This endpoint returns a list of event type names which are visible to you. You may use these event type names to query the API for specific event instances of a desired type.
Events APIEvents
Retrieve a custom event definition
Fetch a single custom event definition by name.
Custom Event Definitions APIEvent definition
Retrieve event data
Retrieve instances of event completion data. For example, retrieve all event completions associated with a specific contact.
Events APIEvents
Retrieve event definitions
Search for existing custom event definitions.
Custom Event Definitions APIEvent definition
Send a batch of event completions
Send multiple event completions at once.
Custom Event Definitions API
Send a custom event completion
Endpoint to send an instance of a behavioral event
Custom Behavioral Events APICustom Behavioral Events API1
Update a custom event definition
Update a specific custom event definition by name.
Custom Event Definitions APIEvent definition
Update an existing custom event property
Updates an existing property in a custom event definition.
Custom Event Definitions APIEvent definition
Add tokens to an existing template
Update an existing event type template with new tokens.
Timeline APITokens
Create an event template
Event templates define the general structure for a custom timeline event, and enable you to send event data to HubSpot. A template includes formatted copy for its heading and details, as well as any custom property definitions. A single app can include up to 750 event templates.<br/><Warning>the `v1` and `v3` timeline events APIs are only available for app partners with existing `v1`/`v3` timeline events defined in their public app. <ul><li>If your app doesn't include any timeline events yet, requests to this endpoint will fail. Instead, you can get started on [latest version of the developer platform](/apps/developer-platform/build-apps/overview). Note that you'll need to request approval before you can define app events for your app. Learn more in the [app events overview](/apps/developer-platform/add-features/app-events/overview).</li><li>If your app includes a `v1`/`v3` timeline event, learn how to [migrate it to the developer platform](/apps/developer-platform/add-features/app-events/create-and-manage-event-types#migrate-an-existing-timeline-event-type). You don't need to request approval before migrating existing event types.</li></ul>If you're not an app partner, you can send custom event data to HubSpot using the [custom events API](/api-reference/events-manage-event-definitions-v3/guide).</Warning>
Timeline APITemplates
Create multiple events
Batch create multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via `objectPropertyName`, this call will also attempt to updates those properties, or add them if they don't exist.
Timeline APIEvents
Create new calling extension settings for a specific app.
Used to set the menu label, target iframe URL, and dimensions for your calling extension.
Callings Extensions APISettings
Create new channel connection settings for a specific app.
Configure [channel connection settings](https://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling#create-channel-connection-settings) for the app.
Callings Extensions API
Create or update settings
Updates the settings for a video conference application with the specified ID.
Video Conference Ext APISettings1
Create recording settings for an app.
Create recording settings for an app.
Callings Extensions APIRecording_Settings
Delete an event template
Delete an event type template by ID.
Timeline APITemplates
Delete a template token
Delete an existing token from a specific event type template.
Timeline APITokens
Delete settings
Deletes the settings for a video conference application with the specified ID.
Video Conference Ext APISettings1
Delete the calling extension settings for a specific app.
Deletes this calling extension. This will remove your service as an option for all connected accounts.
Callings Extensions APISettings
Get all event templates
Retrieve all templates defined for an app.
Timeline APITemplates
Get an event instance
Retrieve an event instance, specified by template ID and event ID.
Timeline APIEvents
Get an event template
Retrieve an event type template by ID.
Timeline APITemplates
Get event details
Retrieve details for a specific event, specified by template ID and event ID.
Timeline APIEvents
Get event render by ID
Retrieve the template renderings in HTML format for a specific event.
Timeline APIEvents
Get settings
Return the settings for a video conference application with the specified ID.
Video Conference Ext APISettings1
Mark a call recording as ready for retrieval.
Mark a call recording as ready for transcription, specifying the call by its ID (`engagementid`).
Callings Extensions API
Remove the channel connection settings for a specific app.
Delete the [channel connection settings](https://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling#delete-existing-channel-connection-settings) for the app.
Callings Extensions API
Retrieve recording settings for an app.
Retrieve recording settings for an app.
Callings Extensions APIRecording_Settings
Retrieve the calling extension settings for a specific app.
Returns the calling extension settings configured for your app.
Callings Extensions APISettings
Retrieve the channel connection settings for a specific app.
Retrieve the settings related to the app's [channel connection](https://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling#fetch-existing-channel-connection-settings).
Callings Extensions API
Send event data (single)
Send a single instance of event data to a specified event type.
Timeline APIEvents
Submit details of an inbound call to the CRM.
This endpoint allows you to submit information about an inbound call to the CRM system. The request must include details such as the external call ID, call status, and involved phone numbers. This operation helps in logging and managing inbound call data within the CRM.
Callings Extensions API
Update an event template
Update an existing event template, specified by ID.
Timeline APITemplates
Update a template token
Update an event type template token, specified by token name.
Timeline APITokens
Update recording settings for an app.
Update recording settings for an app.
Callings Extensions APIRecording_Settings
Update the calling extension settings for a specific app.
Updates existing calling extension settings.
Callings Extensions APISettings
Update the channel connection settings for a specific app.
Update existing [channel connection settings](https://developers.hubspot.com/docs/guides/api/crm/extensions/third-party-calling#manage-the-webhook-settings-for-channel-connection) for your app.
Callings Extensions API
Execute a GraphQL operation
To make an API request to the /collector/graphql endpoint, the following scopes are required: - collector.graphql_schema.read - collector.graphql_query.execute Note: You must also include any scopes that correspond to the data sources in your query. For example, the crm.objects.contacts.read scope is required if you're fetching contacts in your query. Once a user has authorized the required scopes above, you can make a POST request to the /collector/graphql endpoint and include the following fields:
/
Add asset association
Associate a specified asset with a campaign. Important: Currently, only the following asset types can be associated and disassociated via the API: Forms, Static lists, External website pages
Campaigns APIAsset
Add budget item
Add a new budget item to the campaign
Campaigns API
Archive a form definition
Archive a form definition. New submissions will not be accepted and the form definition will be permanently deleted after 3 months.
Forms APIForms
Associate a list with a marketing event
Associates a list with a marketing event by marketing event id and ILS list id
Marketing Events APIv3 [legacy]
Associate a list with a marketing event
Associates a list with a marketing event by external account id, external event id, and ILS list id
Marketing Events APIv3 [legacy]
Associate a list with a marketing event
Associates a list with a marketing event by external account id, external event id, and ILS list id
Marketing Events API2026-03 [latest]List Associations
Associate a list with a marketing event
Associates a list with a marketing event by marketing event id and ILS list id
Marketing Events API2026-03 [latest]List Associations
Batch retrieve contacts who have opted out of all communications
Checks whether a set of contacts have opted out of all communications.
Subscription Preferences V4 APIPublic_Status
Batch retrieve subscription statuses
Batch retrieve subscription statuses for a set of contacts.
Subscription Preferences V4 APIPublic_Status
Batch unsubscribe contacts from all subscriptions
Unsubscribe a set of contacts from all email subscriptions.
Subscription Preferences V4 APIPublic_Status
Batch update subscription status
Update the subscription status for a set of contacts.
Subscription Preferences V4 APIPublic_Status
Campaign search
This endpoint allows users to search for and return a page of campaigns based on various query parameters. Users can filter by name, sort, and paginate through the campaigns, as well as control which properties are returned in the response.
Campaigns APISearch1
Clone a marketing email
This will create a duplicate email with the same properties as the original, with the exception of a unique ID.
Marketing Emails API
Create a batch of campaigns
This endpoint creates a batch of campaigns. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request.
Campaigns APIBatch12
Create a campaign
Create a campaign with the given properties and return the campaign object, including the campaignGuid and created properties.
Campaigns APIBasic12
Create a form
Add a new `hubspot` form
Forms APIForms
Create a marketing event
Creates a new marketing event in HubSpot
Marketing Events APIv3 [legacy]Basic
Create a marketing event
Creates a new marketing event in HubSpot
Marketing Events API2026-03 [latest]Basic1
Create a new marketing email
Use this endpoint to create a new marketing email.
Marketing Emails APIMarketing Emails
Create an A/B test variation of a marketing email
Create a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created.
Marketing Emails API
Create campaign spend item
Create a new campaign spend item
Campaigns API
Create or update a marketing event
Upsets a Marketing Event. If there is an existing Marketing event with the specified id, it will be updated; otherwise a new event will be created.
Marketing Events APIv3 [legacy]Basic
Create or update a marketing event
Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.
Marketing Events API2026-03 [latest]Basic1
Create or update draft version
Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.
Marketing Emails APIMarketing Emails
Create or Update Multiple Marketing Events
Upset multiple Marketing Event. If there is an existing Marketing event with the specified id, it will be updated; otherwise a new event will be created.
Marketing Events APIv3 [legacy]Batch
Create or Update Multiple Marketing Events
Upserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created. Only Marketing Events originally created by the same app can be updated.
Marketing Events API2026-03 [latest]Batch1
Delete a batch of campaigns
This endpoint deletes a batch of campaigns. The maximum number of items in a batch request is 50. The response will always be 204 No Content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.
Campaigns APIBatch12
Delete a marketing email
Delete a marketing email
Marketing Emails APIMarketing Emails
Delete budget item
Delete a specific budget item by ID
Campaigns API
Delete campaign
Delete a specified campaign from the system. This call will return a 204 No Content response regardless of whether the campaignGuid provided corresponds to an existing campaign or not.
Campaigns APIBasic12
Delete campaign spend item
Delete a specific campaign spend item by ID
Campaigns API
Delete Marketing Event by External Ids
Deletes an existing Marketing Event with the specified id, if one exists.
Marketing Events APIv3 [legacy]Basic
Delete Marketing Event by External Ids
Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app can be deleted.
Marketing Events API2026-03 [latest]Basic1
Delete Marketing Event by objectId
Deletes the existing Marketing Event with the specified objectId, if it exists.
Marketing Events APIv3 [legacy]
Delete Marketing Event by objectId
Deletes the existing Marketing Event with the specified objectId, if it exists.
Marketing Events API2026-03 [latest]Basic1
Delete Multiple Marketing Events by External Ids
Bulk delete a number of marketing events in HubSpot
Marketing Events APIv3 [legacy]Batch
Delete Multiple Marketing Events by External Ids
Deletes multiple Marketing Events based on externalAccountId, externalEventId, and appId. Only Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint.
Marketing Events API2026-03 [latest]Batch1
Delete Multiple Marketing Events by ObjectId
Deletes multiple Marketing Events from the portal based on their objectId, if they exist. Responses: 204: Returned if all specified Marketing Events were successfully deleted. 207: Returned if some objectIds did not correspond to any existing Marketing Events.
Marketing Events APIv3 [legacy]
Delete Multiple Marketing Events by ObjectId
Deletes multiple Marketing Events from the portal based on their objectId, if they exist. Responses: 204: Returned if all specified Marketing Events were successfully deleted. 207: Returned if some objectIds did not correspond to any existing Marketing Events.
Marketing Events API2026-03 [latest]Batch1
Disassociate a list from a marketing event
Disassociates a list from a marketing event by marketing event id and ILS list id
Marketing Events APIv3 [legacy]
Disassociate a list from a marketing event
Disassociates a list from a marketing event by external account id, external event id, and ILS list id
Marketing Events APIv3 [legacy]
Disassociate a list from a marketing event
Disassociates a list from a marketing event by external account id, external event id, and ILS list id
Marketing Events API2026-03 [latest]List Associations
Disassociate a list from a marketing event
Disassociates a list from a marketing event by marketing event id and ILS list id
Marketing Events API2026-03 [latest]List Associations
Fetch contact IDs
Fetch the list of contact IDs for the specified campaign and contact type
Campaigns APIReports
Fetch revenue
Fetch revenue attribution report data for a specified campaign
Campaigns APIReports
Find App-Specific Marketing Events by External Event Id
Search for marketing events that have an event id that starts with the query string
Marketing Events APIv3 [legacy]Search
Find App-Specific Marketing Events by External Event Id
Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request. Marketing Events created by other apps will not be included in the results.
Marketing Events API2026-03 [latest]Identifiers
Find Marketing Events by External Event Id
This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request. It retrieves the objectId and additional event details for each matching Marketing Event. Since multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results. Note: Marketing Events become searchable by externalEventId a few minutes after creation.
Marketing Events APIv3 [legacy]
Find Marketing Events by External Event Id
This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request. It retrieves the objectId and additional event details for each matching Marketing Event. Since multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results. Note: Marketing Events become searchable by externalEventId a few minutes after creation.
Marketing Events API2026-03 [latest]Identifiers
Get a form definition
Returns a form based on the form ID provided.
Forms APIForms
Get aggregated statistics
Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span.
Marketing Emails APIStatistics
Get aggregated statistic intervals
Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time.
Marketing Emails APIStatistics
Get a list of forms
Returns a list of forms based on the search filters. By default, it returns the first 20 `hubspot` forms
Forms APIForms
Get all marketing emails
The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options.
Marketing Emails APIMarketing Emails
Get all marketing event
Returns all Marketing Events available on the portal, along with their properties, regardless of whether they were created manually or through the application. The marketing events returned by this endpoint are sorted by objectId.
Marketing Events APIv3 [legacy]
Get a revision of a marketing email
Get a specific revision of a marketing email.
Marketing Emails APIMarketing Emails
Get Campaign Metrics
This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.
Campaigns APIReports
Get draft version of a marketing email
Get the draft version of an email (if it exists). If no draft version exists, the published email is returned.
Marketing Emails APIMarketing Emails
Get lists associated with a marketing event
Gets lists associated with a marketing event by external account id and external event id
Marketing Events APIv3 [legacy]
Get lists associated with a marketing event
Gets lists associated with a marketing event by marketing event id
Marketing Events APIv3 [legacy]
Get lists associated with a marketing event
Gets lists associated with a marketing event by external account id and external event id
Marketing Events API2026-03 [latest]List Associations
Get lists associated with a marketing event
Gets lists associated with a marketing event by marketing event id
Marketing Events API2026-03 [latest]List Associations
Get Marketing Event by External IDs
Returns the details of the Marketing Event with the specified id, if one exists.
Marketing Events APIv3 [legacy]Basic
Get Marketing Event by External IDs
Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists. Only Marketing Events created by the same app making the request can be retrieved.
Marketing Events API2026-03 [latest]Basic1
Get Marketing Event by objectId
Returns the details of a Marketing Event with the specified objectId, if it exists.
Marketing Events APIv3 [legacy]
Get Marketing Event by objectId
Returns the details of a Marketing Event with the specified objectId, if it exists.
Marketing Events API2026-03 [latest]Basic1
get-/marketing/marketing-events/2026-03_/marketing/marketing-events/v3
get-/marketing/marketing-events/2026-03_/marketing/marketing-events/v3
Marketing Events API2026-03 [latest]Basic1
Get revisions of a marketing email
Get a list of all versions of a marketing email, with each entry including the full state of that particular version. The current revision has the ID -1.
Marketing Emails APIMarketing Emails
Get subscription definitions
Get a list of all subscription definitions for the portal
Subscription Preferences V3 APIDefinition
Get subscription preferences for a specific contact
Retrieve a contact's current email subscription preferences.
Subscription Preferences V4 APIPublic_Status
Get subscription statuses for a contact
Returns a list of subscriptions and their status for a given contact.
Subscription Preferences V3 APIStatus
Get the details of a specified marketing email
Get the details for a marketing email.
Marketing Emails APIMarketing Emails
Get the variation of a an A/B marketing email
This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa.
Marketing Emails APIMarketing Emails
List assets
This endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type. Asset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.
Campaigns APIAsset
Mark a marketing event as cancelled
Mark a marketing event as cancelled.
Marketing Events APIv3 [legacy]Basic
Mark a marketing event as cancelled
Mark a marketing event as cancelled.
Marketing Events API2026-03 [latest]Event Status
Mark a marketing event as completed
Mark a marketing event as completed
Marketing Events APIv3 [legacy]Marketing_Events_External
Mark a marketing event as completed
Mark a marketing event as completed
Marketing Events API2026-03 [latest]Event Status
Partially update a form definition
Update some of the form definition components
Forms APIForms
post-/communication-preferences/v4/links/generate_/communication-preferences/v4/links/generate
post-/communication-preferences/v4/links/generate_/communication-preferences/v4/links/generate
Subscription Preferences V4 APIPublic_Link_Generation
Publish or send a marketing email
If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email.
Marketing Emails API
Read a batch of campaigns
This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request. If duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.
Campaigns APIBatch12
Read a campaign
Get a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.
Campaigns APIBasic12
Read budget
Retrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget. Budget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer
Campaigns APIBudget
Read campaign spend item
Read a campaign spend item by its spendId
Campaigns API
Read participations breakdown by Contact identifier
Read Contact's participations by identifier - email or internal id.
Marketing Events APIv3 [legacy]
Read participations breakdown by Contact identifier
Read Contact's participations by identifier - email or internal id.
Marketing Events API2026-03 [latest]Participant State
Read participations breakdown by Marketing Event external identifier
Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.
Marketing Events APIv3 [legacy]
Read participations breakdown by Marketing Event external identifier
Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.
Marketing Events API2026-03 [latest]Participant State
Read participations breakdown by Marketing Event internal identifier
Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.
Marketing Events APIv3 [legacy]
Read participations breakdown by Marketing Event internal identifier
Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.
Marketing Events API2026-03 [latest]Participant State
Read participations counters by Marketing Event external identifier
Read Marketing event's participations counters by externalAccountId and externalEventId pair.
Marketing Events APIv3 [legacy]
Read participations counters by Marketing Event external identifier
Read Marketing event's participations counters by externalAccountId and externalEventId pair.
Marketing Events API2026-03 [latest]Participant State
Read participations counters by Marketing Event internal identifier
Read Marketing event's participations counters by internal identifier marketingEventId.
Marketing Events APIv3 [legacy]
Read participations counters by Marketing Event internal identifier
Read Marketing event's participations counters by internal identifier marketingEventId.
Marketing Events API2026-03 [latest]Participant State
Record a subscriber state by contact email
Record a subscription state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created.
Marketing Events APIv3 [legacy]Subscriber State Changes
Record a subscriber state by contact email
Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts.
Marketing Events API2026-03 [latest]Subscriber State Changes1
Record a subscriber state by contact ID
Record a subscription state between multiple HubSpot contacts and a marketing event, using HubSpot contact ids. Note that the contact must already exist in HubSpot; a contact will not be create.
Marketing Events APIv3 [legacy]Subscriber State Changes
Record a subscriber state by contact ID
Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.
Marketing Events API2026-03 [latest]Subscriber State Changes1
Record Participants by ContactId with Marketing Event External Ids
Record a subscription state between multiple HubSpot contacts and a marketing event, using HubSpot contact ids.
Marketing Events APIv3 [legacy]Attendance Subscriber State Changes
Record Participants by ContactId with Marketing Event External Ids
Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt
Marketing Events API2026-03 [latest]Event Attendees
Record Participants by ContactId with Marketing Event Object Id
Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt
Marketing Events APIv3 [legacy]
Record Participants by ContactId with Marketing Event Object Id
Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt
Marketing Events API2026-03 [latest]Event Attendees
Record Participants by Email with Marketing Event External Ids
Record a subscription state between multiple HubSpot contacts and a marketing event, using contact email addresses. If contact is not present it will be automatically created.
Marketing Events APIv3 [legacy]Attendance Subscriber State Changes
Record Participants by Email with Marketing Event External Ids
Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt
Marketing Events API2026-03 [latest]Event Attendees
Record Participants by Email with Marketing Event Object Id
Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt
Marketing Events APIv3 [legacy]
Record Participants by Email with Marketing Event Object Id
Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt
Marketing Events API2026-03 [latest]Event Attendees
Remove asset association
Disassociate a specified asset from a campaign. Important: Currently, only the following asset types can be associated and disassociated via the API: Forms, Static lists, External website pages
Campaigns APIAsset
Reset the draft version
Resets the draft back to a copy of the live object.
Marketing Emails APIMarketing Emails
Restore a revision of a marketing email
Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number.
Marketing Emails APIMarketing Emails
Restore a revision of a marketing email to DRAFT state
Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten.
Marketing Emails APIMarketing Emails
Retrieve a contact's unsubscribed status
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.
Subscription Preferences V4 APIPublic_Status
Retrieve all subscription status definitions
Get a list of subscription status definitions from the account.
Subscription Preferences V4 APIPublic_Definition
Retrieve the application settings
Retrieve the current settings for the application.
Marketing Events APIv3 [legacy]Settings
Retrieve the application settings
Retrieve the current settings for the application.
Marketing Events API2026-03 [latest]Settings1
Send an email
Send an email
Single-Send APISingle_Send1
Send a single send transactional email asynchronously.
Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.
Transactional Email APISingle_Send
Subscribe a contact
Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error.
Subscription Preferences V3 APIStatus
Unpublish or cancel a marketing email
If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible.
Marketing Emails API
Unsubscribe a contact
Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.
Subscription Preferences V3 APIStatus
Unsubscribe a contact from all subscriptions
Unsubscribe a contact from all email subscriptions.
Subscription Preferences V4 APIPublic_Status
Update a batch of campaigns
This endpoint updates a batch of campaigns based on the provided input data. The maximum number of items in a batch request is 50. If an empty string ("") is passed for any property in the Batch Update, it will reset that property's value.
Campaigns APIBatch12
Update a contact's subscription status
Set the subscription status of a specific contact.
Subscription Preferences V4 APIPublic_Status
Update a form definition
Update all fields of a hubspot form definition.
Forms APIForms
Update a marketing email
Change properties of a marketing email.
Marketing Emails APIMarketing Emails
Update budget item
Update a specific budget item by ID
Campaigns API
Update campaign
Perform a partial update of a campaign identified by the specified campaignGuid. Provided property values will be overwritten. Read-only and non-existent properties will cause 400 error. If an empty string is passed for any property in the Batch Update, it will reset that property's value.
Campaigns APIBasic12
Update campaign spend item
Update a specific campaign spend item by ID
Campaigns API
Update Marketing Event by External IDs
Updates an existing Marketing Event with the specified id, if one exists.
Marketing Events APIv3 [legacy]Basic
Update Marketing Event by External IDs
Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists. Only Marketing Events created by the same app can be updated.
Marketing Events API2026-03 [latest]Basic1
Update Marketing Event by objectId
Updates the details of an existing Marketing Event identified by its objectId, if it exists.
Marketing Events APIv3 [legacy]
Update Marketing Event by objectId
Updates the details of an existing Marketing Event identified by its objectId, if it exists.
Marketing Events API2026-03 [latest]Basic1
Update Multiple Marketing Events by ObjectId
Updates multiple Marketing Events on the portal based on their objectId, if they exist.
Marketing Events APIv3 [legacy]
Update Multiple Marketing Events by ObjectId
Updates multiple Marketing Events on the portal based on their objectId, if they exist.
Marketing Events API2026-03 [latest]Batch1
Update the application settings
Create or update the current settings for the application.
Marketing Events APIv3 [legacy]Settings
Update the application settings
Create or update the current settings for the application.
Marketing Events API2026-03 [latest]Settings1
Adds a user
New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot.
User Provisioning APIUsers
Add a new currency with central exchange rates.
Create a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here.
Currencies API
Add a new exchange rate
Add a new exchange rate
Currencies APICurrency
Archive
Move an Object identified by `{userId}` to the recycling bin.
Users API
Archive a batch of users by ID
Archive a batch of users by ID
Users API
Change the visibility of a specific currency pairs
Change the visibility of a specific currency pairs
Currencies APICurrency
Create
Create a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided.
Users API
Create a batch of users
Create a batch of users
Users API
Create multiple exchange rates
Create multiple exchange rates
Currencies APICurrency
Create or update a batch of users by unique property values
Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.
Users API
Get all currency codes
Get all currency codes
Currencies APICurrency
Get all current exchange rates
Get all current exchange rates
Currencies APICurrency
Get all tax rates
Retrieve a paginated list of all tax rates set up in the account tax rate library
Tax Rates APIPublic_Tax_Rate
Get a specific tax rate
Retrieve a specific tax rate by its `taxRateGroupId`.
Tax Rates APIPublic_Tax_Rate
Get Business Units for a user
Get Business Units identified by `userId`. The `userId` refers to the user’s ID.
Business Unit APIBusiness Unit
Get exchange rates
Get exchange rates
Currencies APICurrency
Get the company currency
Get the company currency
Currencies APICurrency
Get the details for a specific exchange rate
Get the details for a specific exchange rate
Currencies APICurrency
List
Read a page of users. Control what is returned via the `properties` query param.
Users APIBasic
Modifies a user
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.
User Provisioning APIUsers
post-/crm/v3/objects/users/search
post-/crm/v3/objects/users/search
Users APISearch
Read
Read an Object identified by `{userId}`. `{userId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
Users APIBasic
Read a batch of users by internal ID, or unique property values
Read a batch of users by internal ID, or unique property values
Users APIBatch
Removes a user
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.
User Provisioning APIUsers
Retrieves a list of users from an account
Retrieves a list of users from an account
User Provisioning APIUsers
Retrieves a user
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.
User Provisioning APIUsers
Retrieves the roles on an account
Retrieves the roles on an account
User Provisioning APIRoles
Retrieve currencies not supported by central exchange rates.
Retrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated.
Currencies API
Retrieve information about the central exchange rates feature.
Retrieve details on whether the central exchange rates feature is enabled for the portal.
Currencies API
Retrieve multiple rates
Retrieve multiple rates
Currencies APICurrency
See details about this account's teams
View teams for this account
User Provisioning APITeams
Set or update the company currency.
Set or update the company currency.
Currencies APICurrency
Update
Perform a partial update of an Object identified by `{userId}`or optionally a unique property value as specified by the `idProperty` query param. `{userId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.
Users API
Update a batch of users by internal ID, or unique property values
Update a batch of users by internal ID, or unique property values
Users API
Update a conversion rate
Update a conversion rate
Currencies APICurrency
Update multiple exchange rates
Update multiple exchange rates
Currencies APICurrency
Batch create event subscriptions
Batch create event subscriptions
Webhooks APIv3 [legacy]Subscriptions
Batch create event subscriptions
Batch create event subscriptions for the specified app.
Webhooks API2026-03 [latest]1Batch1
Batch read
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.
Webhooks API2026-03 [latest]1Batch1
Batch read
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 in the required format.
Webhooks API2026-03 [latest]1Batch1
Create an event subscription
Create an event subscription
Webhooks APIv3 [legacy]Subscriptions
Create an event subscription
Create new event subscription for the specified app.
Webhooks API2026-03 [latest]1Basic1
Create Filter
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.
Webhooks API2026-03 [latest]1Advanced1
Create Snapshot
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 limits.
Webhooks API2026-03 [latest]1Advanced1
Create Subscription
Create a new subscription in the Webhooks Journal for the specified version. This endpoint allows you to define the subscription details by providing the necessary information in the request body. It supports various types of subscriptions, including object, association, event, app lifecycle event, list membership, and GDPR privacy deletion. Ensure that all required fields are included in the request to successfully create a subscription.
Webhooks API2026-03 [latest]1Basic1
Delete event subscription
Delete event subscription
Webhooks APIv3 [legacy]Subscriptions
Delete event subscription
Delete an existing event subscription by ID.
Webhooks API2026-03 [latest]1Basic1
Delete filter
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.
Webhooks API2026-03 [latest]1Basic1
Delete Subscription
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.
Webhooks API2026-03 [latest]1Basic1
Delete subscription
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.
Webhooks API2026-03 [latest]1Basic1
Delete webhook settings
Delete webhook settings
Webhooks APIv3 [legacy]Settings
Delete webhook settings
Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created.
Webhooks API2026-03 [latest]1Basic1
Fetch Batch
Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through large sets of webhook data. The number of entries returned is determined by the 'count' parameter.
Webhooks API2026-03 [latest]1Batch1
Fetch Batch
Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a defined number of entries, which can be useful for processing large datasets in manageable chunks.
Webhooks API2026-03 [latest]1Batch1
Fetch earliest batch
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.
Webhooks API2026-03 [latest]1Batch1
Fetch Earliest Batch
Retrieve the earliest batch of webhook journal entries for a specified count. This endpoint is useful for accessing historical webhook data in batches, allowing you to process or analyze older entries. The number of entries retrieved is determined by the count parameter.
Webhooks API2026-03 [latest]1Batch1
List Subscriptions
Retrieve a list of webhook journal subscriptions for the specified version. This endpoint allows you to view all active subscriptions without pagination. It is useful for monitoring and managing webhook subscriptions in your HubSpot account.
Webhooks API2026-03 [latest]1Basic1
Read an event subscription
Read an event subscription
Webhooks APIv3 [legacy]Subscriptions
Read an event subscription
Retrieve a specific event subscription by ID.
Webhooks API2026-03 [latest]1Basic1
Read event subscriptions
Read event subscriptions
Webhooks APIv3 [legacy]Subscriptions
Read event subscriptions
Retrieve event subscriptions for the specified app.
Webhooks API2026-03 [latest]1Basic1
Read webhook settings
Read webhook settings
Webhooks APIv3 [legacy]Settings
Read webhook settings
Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date.
Webhooks API2026-03 [latest]1Basic1
Retrieve batch
Retrieve the latest batch of webhook journal entries up to the specified count. This endpoint is useful for fetching recent webhook data for analysis or processing. The count parameter determines the maximum number of entries to return.
Webhooks API2026-03 [latest]1Batch1
Retrieve earliest
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve earliest entry
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve filter
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve filters
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve latest
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve Latest Batch
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.
Webhooks API2026-03 [latest]1Batch1
Retrieve latest journal
Retrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events and their statuses, allowing you to monitor and debug webhook activity effectively.
Webhooks API2026-03 [latest]1Basic1
Retrieve Next Batch
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve Next Entries
Retrieve the next set of entries from the webhooks journal starting from a specified offset. This endpoint is useful for paginating through journal entries to process or analyze webhook events sequentially.
Webhooks API2026-03 [latest]1Basic1
Retrieve status
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve status
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.
Webhooks API2026-03 [latest]1Basic1
Retrieve subscription
Retrieve details of a specific webhook subscription using its unique identifier. This endpoint is useful for obtaining information about a particular subscription, such as its actions, object type, and associated properties.
Webhooks API2026-03 [latest]1Basic1
Update an event subscription
Update an event subscription
Webhooks APIv3 [legacy]Subscriptions
Update an event subscription
Update an existing event subscription by ID.
Webhooks API2026-03 [latest]1Basic1
Update webhook settings
Update webhook settings
Webhooks APIv3 [legacy]Settings
Update webhook settings
Update webhook settings for the specified app.
Webhooks API2026-03 [latest]1Basic1
FAQ

HubSpot integration, answered

How do AI agents use HubSpot through Open Connector?
Your user connects HubSpot once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes HubSpot tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a HubSpot MCP server?
Yes. Open Connector can serve HubSpot as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call HubSpot actions with credentials injected server-side.
Where do HubSpot credentials live?
In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents HubSpot — keep the keys.

Open source, self-hostable, with HubSpot credentials that never leave your infrastructure. Run it from source today.

View source on GitHubHow the MCP gateway works →