HubSpot

Get account details

get-/account-info/v3/activity/audit-logs

get-/account-info/2025-09/activity/audit-logs

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

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

Get login activity.

Get login activity.

Get security activity

Get security activity

Get daily API usage

Retrieve account details such as the account type, time zone, currencies, and data hosting location.

Retrieve account details such as the account type, time zone, currencies, and data hosting location.

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).

Retrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history).

Retrieve the daily API usage for private apps in the account, along with information about usage limits.

Retrieve the daily API usage for private apps in the account, along with information about usage limits.

Retrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history).

Archive a function for a definition

Complete a batch of callbacks

Completes a callback

Create a new custom action definition

Delete a function for a definition

Delete an action definition

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.

Enroll a contact in a sequence

Retrieve all workflows from an account.

Retrieve emails sent by a workflow by ID.

Retrieve all details for a specific workflow by ID.

get-/automation/v4/sequences

Insert a function for a definition

Create a new workflow.

Retrieve a batch of workflows by ID.

Retrieve the IDs of v3 workflows that have been migrated to the v4 API.

Update a workflow by ID.

Retrieve a custom action definition

Retrieve a function from a given definition

Retrieve a specific revision of a definition

Retrieve custom action definitions

Retrieve details for a sequence

Retrieve functions by a type for a given definition

Retrieve functions for a given definition

Retrieve revisions for a given definition

Retrieve the enrollment status of a contact

Update a function for a definition

Update an existing action definition

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.

Archive (soft delete) an existing HubDB table. This archives both the published and draft versions.

Archive multiple properties

Attach a Blog Author to a multi-language group.

Attach a Blog Post to a multi-language group.

Attach a Blog Tag to a multi-language group.

Attach a blog to a multi-language group.

Attach a landing page to a multi-language group.

Attach a site page to a multi-language group.

Clone a Blog Post.

Clone a Landing Page

Clones a single row in the `draft` version of the table.

Clone a Site Page

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`.

Clones rows in the `draft` version of the specified table, given a set of row ids. Maximum of 100 row ids per call.

Create the Blog Author objects detailed in the request body.

Create the Blog Post objects detailed in the request body.

Create the Blog Tag objects detailed in the request body.

Create the Folder objects detailed in the request body.

Create the Landing Page objects detailed in the request body.

Create the Site Page objects detailed in the request body.

Create an attention span event

Create a new A/B test variation based on the information provided in the request body.

Create a new A/B test variation based on the information provided in the request body.

Create a new Blog Author.

Create a new Blog Post.

Create a new Blog Tag.

Create a new Folder

Create a new Landing Page

Create a new language variation from an existing blog

Create a new language variation from an existing Blog Tag

Create a new language variation from an existing site page

Create a new language variation from an existing landing page

Create a new language variation from an existing Blog Author.

Create a new language variation from an existing Blog Post

Create a new object type

Create a new property

Create a new property group

Create a new Site Page

Creates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.

Create a played event

Create a quartile event

Creates and configures a new URL redirect.

Create association definition

Create multiple properties

Create or update event visibility settings

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.

Delete the Blog Author objects identified in the request body.

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.

Delete the Blog Tag objects identified in the request body.

Delete the Folder objects identified in the request body.

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.

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.

Delete the Blog Author object identified by the id in the path.

Delete the Blog Post object identified by the id in the path.

Delete the Blog Tag object identified by the id in the path.

Deletes the file at the specified path in the specified environment.

Delete the Folder object identified by the id in the path.

Delete the Landing Page object identified by the id in the path.

Delete an association definition

Delete an oEmbed domain

Delete a property

Delete a property group

Delete one existing redirect, so it is no longer mapped.

Delete the Site Page object identified by the id in the path.

Detach a Blog Author from a multi-language group.

Detach a blog from a multi-language group.

Detach a Blog Post from a multi-language group.

Detach a Blog Tag from a multi-language group.

Detach a landing page from a multi-language group.

Detach a site page from a multi-language group.

Downloads the byte contents of the file at the specified path in the specified environment.

End an active A/B test and designate a winner.

End an active A/B test and designate a winner.

Exports the `draft` version of a table to CSV / EXCEL format.

Exports the `published` version of a table to CSV / EXCEL format.

Extract a zip file

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.

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.

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.

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.

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.

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.

Returns the details for the `published` version of each table defined in an account, including column definitions.

Get all schemas

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.

Get an oEmbed domain

Get a single row by ID from a table's `draft` version.

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.

Returns rows in the `draft` version of the specified table, given a set of row ids.

Returns a single domains with the id specified.

Get a specific property group

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.

Returns all existing domains that have been created. Results can be limited and filtered by creation or updated date.

Returns all existing URL redirects. Results can be limited and filtered by creation or updated date.

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.

Returns the details for a single existing URL redirect by ID.

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.

Get extraction status

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.

Get object types for a supported media

Get oEmbed domains

Get property groups

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.

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.

Get the details for a property

Get the details for multiple properties

Gets the metadata object for the file at the specified path in the specified environment.

Get the properties for an object type.

Get the schema for an object type

Permanently deletes a row from a table's `draft` version.

Permanently deletes rows from the `draft` version of the table, given a set of row ids. Maximum of 100 row ids per call.

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.

Take any changes from the draft version of the Blog Post and apply them to the live version.

Take any changes from the draft version of the Landing Page and apply them to the live version.

Take any changes from the draft version of the Site Page and apply them to the live version.

Returns audit logs based on filters.

Register the media bridge app name

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.

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.

Rerun a previous A/B test.

Rerun a previous A/B test.

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.

Discards any edits and resets the draft to the live version.

Discards any edits and resets the draft to the live version.

Discards any edits and resets the draft to the live version.

Takes a specified version of a blog post and restores it.

Takes a specified version of a blog post, sets it as the new draft version of the blog post.

Takes a specified version of a Folder and restores it.

Takes a specified version of a Landing Page and restores it.

Takes a specified version of a Landing Page, sets it as the new draft version of the Landing Page.

Takes a specified version of a Site Page and restores it.

Takes a specified version of a Site Page, sets it as the new draft version of the Site Page.

Retrieve the Blog Author objects identified in the request body.

Retrieve the Blog Post objects identified in the request body.

Retrieve the Blog Tag objects identified in the request body.

Update the Folder objects identified in the request body.

Retrieve the Landing Page objects identified in the request body.

Retrieve the Site Page objects identified in the request body.

Retrieve the Blog object identified by the id in the path.

Retrieve the Blog Author object identified by the id in the path.

Retrieve the Blog Post object identified by the id in the path.

Retrieve the Blog Tag object identified by the id in the path.

Retrieve the Folder object identified by the id in the path.

Retrieve the Landing Page object identified by the id in the path.

Retrieve the Site Page object identified by the id in the path.

Retrieve the full draft version of the Blog Post.

Retrieve the full draft version of the Landing Page.

Retrieve the full draft version of the Site Page.

Retrieves all the previous versions of a Blog

Retrieves all the previous versions of a blog post.

Retrieves all the previous versions of a Folder.

Retrieves all the previous versions of a Landing Page.

Retrieves all the previous versions of a Site Page.

Retrieves a previous version of a Blog

Retrieves a previous version of a blog post.

Retrieves a previous version of a Folder

Retrieves a previous version of a Landing Page

Retrieves a previous version of a Site Page

Returns the details for each draft table defined in the specified account, including column definitions.

Schedule a Blog Post to be Published.

Schedule a Landing Page to be Published

Schedule a Site Page to be Published

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.

Set a blog as the primary language of a multi-language group.

Set a Blog Tag as the primary language of a multi-language group.

Set a site page as the primary language of a multi-language group.

Set a landing page as the primary language of a multi-language group.

Set a Blog Author as the primary language of a multi-language group.

Set a Blog Post as the primary language of a multi-language group.

Set up a new oEmbed domain

Unpublishes the table, meaning any website pages using data from the table will not render any data.

Update the Blog Author objects identified in the request body.

Update the Blog Post objects identified in the request body.

Update the Blog Tag objects identified in the request body.

Update the Folder objects identified in the request body.

Update the Landing Page objects identified in the request body.

Update the Site Page objects identified in the request body.

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.

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.

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.

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.

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.

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.

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.

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.

Update an oEmbed domain

Update a property

Update a property group

Updates the settings for an existing URL redirect.

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.

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.

Explicitly set new languages for each blog in a multi-language group.

Explicitly set new languages for each Blog Tag in a multi-language group.

Explicitly set new languages for each site page in a multi-language group.

Explicitly set new languages for each landing page in a multi-language group.

Explicitly set new languages for each Blog Author in a multi-language group.

Explicitly set new languages for each Blog Post in a multi-language group.

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.

Update the media bridge app name

Update the schema for an object type

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.

View event visibility settings

Use this API to archive a registered custom channel

Archive an existing registered custom channel

Archives a single thread. The thread will be permanently deleted 30 days after placed in an archived state.

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.

This API allows you to create one or more accounts that all talk over a single channel but using different delivery identifiers.

Create a new account for a channel. Multiple accounts can communicate over a single channel using different delivery identifiers.

Register a new channel along with its capabilities and the webhook url that will be used to receive messages published over the channel

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.

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.

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.

Get accounts for a channel

Retrieve a list of accounts for a custom channel.

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.

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.

Resolve `ActorId`s to the underlying actors/participants.

Retrieve the details about a custom channel. This API allows you to see a custom channel's current capabilties and other configuration metadata

Retrieve the details about a custom channel. This API allows you to see a custom channel's current capabilties and other configuration metadata

Get all channels for app

Get the PublicConversationsMessage that represents a message sent over a custom channel

Get the details for a specific message sent over a custom channel

Get a single actor.

Get a single channel.

Get a single channel account.

Get a single conversations inbox.

Get a single message.

Returns a single thread.

Get channel accounts.

Get channels.

get-/conversations/custom-channels/2026-03_/conversations/custom-channels/v3

Get conversations inboxes.

Get message history for a thread.

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`.

Get threads.

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.

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.

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.

post-/conversations/custom-channels/2026-03_/conversations/custom-channels/v3

Publish a message over your custom channel

Publish a message over your custom channel

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.

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.

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.

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.

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.

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.

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.

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.

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.

Send a new message on a thread at the current timestamp.

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.

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.

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.

Update the capabilities for an existing. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.

Use this API to update a message's status to indicate if it was successfully sent, failed to send, or was read

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.

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.

Updates a single thread. Either a thread's status can be updated, or the thread can be restored.

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.

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`.

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`.

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`.

Move an Object identified by `{cartId}` to the recycling bin.

Archive multiple appointments using their IDs.

Archive a batch of carts by ID

Archive a batch of commerce payments by ID

Archive a batch of companies

Archive a batch of contacts

Archive a batch of objects