module Hubspot

#Custom Workflow Actions

#Create custom workflow actions

The version of the OpenAPI document: v4

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Custom Workflow Actions

#Create custom workflow actions

The version of the OpenAPI document: v4

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CMS Audit Logs

#Use this endpoint to query audit logs of CMS changes that occurred on your HubSpot account.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CMS Audit Logs

#Use this endpoint to query audit logs of CMS changes that occurred on your HubSpot account.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Blog Post endpoints

#"Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags"

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Blog Post endpoints

#"Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags"

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Blog Post endpoints

#"Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags"

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Blog Post endpoints

#"Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags"

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Blog Post endpoints

#"Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags"

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Blog Post endpoints

#"Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags"

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Domains

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Domains

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#HubDB endpoints

#HubDB is a relational data store that presents data as rows, columns, and cells in a table, much like a spreadsheet. HubDB tables can be added or modified [in the HubSpot CMS](knowledge.hubspot.com/cos-general/how-to-edit-hubdb-tables), but you can also use the API endpoints documented here. For more information on HubDB tables and using their data on a HubSpot site, see the [CMS developers site](designers.hubspot.com/docs/tools/hubdb). You can also see the [documentation for dynamic pages](designers.hubspot.com/docs/tutorials/how-to-build-dynamic-pages-with-hubdb) for more details about the `useForPages` field. HubDB tables support `draft` and `live` versions and you can publish and unpublish the live version. This allows you to update data in the table, either for testing or to allow for a manual approval process, without affecting any live pages using the existing data. Draft data can be reviewed, pushed to live version, and published by a user working in HubSpot or published via the API. Draft data can also be discarded, allowing users to go back to the live version of the data without disrupting it. If a table is set to be `allowed for public access`, you can access the published version of the table and rows without any authentication by specifying the portal id via the query parameter `portalId`.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#HubDB endpoints

#HubDB is a relational data store that presents data as rows, columns, and cells in a table, much like a spreadsheet. HubDB tables can be added or modified [in the HubSpot CMS](knowledge.hubspot.com/cos-general/how-to-edit-hubdb-tables), but you can also use the API endpoints documented here. For more information on HubDB tables and using their data on a HubSpot site, see the [CMS developers site](designers.hubspot.com/docs/tools/hubdb). You can also see the [documentation for dynamic pages](designers.hubspot.com/docs/tutorials/how-to-build-dynamic-pages-with-hubdb) for more details about the `useForPages` field. HubDB tables support `draft` and `live` versions and you can publish and unpublish the live version. This allows you to update data in the table, either for testing or to allow for a manual approval process, without affecting any live pages using the existing data. Draft data can be reviewed, pushed to live version, and published by a user working in HubSpot or published via the API. Draft data can also be discarded, allowing users to go back to the live version of the data without disrupting it. If a table is set to be `allowed for public access`, you can access the published version of the table and rows without any authentication by specifying the portal id via the query parameter `portalId`.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CMS Performance API

#Use these endpoints to get a time series view of your website's performance.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CMS Performance API

#Use these endpoints to get a time series view of your website's performance.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CMS Site Search

#Use these endpoints for searching content on your HubSpot hosted CMS website(s).

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CMS Site Search

#Use these endpoints for searching content on your HubSpot hosted CMS website(s).

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#URL redirects

#URL redirect operations

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#URL redirects

#URL redirect operations

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Subscriptions

#Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining to a specific topic, brand, or an entire HubSpot account.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Subscriptions

#Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining to a specific topic, brand, or an entire HubSpot account.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Visitor Identification

#The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Visitor Identification

#The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Associations

#Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Associations

#Associations define the relationships between objects in HubSpot. These endpoints allow you to create, read, and remove associations.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Companies

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Companies

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Contacts

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Contacts

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Deals

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Deals

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Accounting Extension

#These APIs allow you to interact with HubSpot's Accounting Extension. It allows you to: * Specify the URLs that HubSpot will use when making webhook requests to your external accounting system. * Respond to webhook calls made to your external accounting system by HubSpot

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Accounting Extension

#These APIs allow you to interact with HubSpot's Accounting Extension. It allows you to: * Specify the URLs that HubSpot will use when making webhook requests to your external accounting system. * Respond to webhook calls made to your external accounting system by HubSpot

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Calling Extensions API

#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the Call action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Calling Extensions API

#Provides a way for apps to add custom calling options to a contact record. This works in conjunction with the [Calling SDK](#), which is used to build your phone/calling UI. The endpoints here allow your service to appear as an option to HubSpot users when they access the Call action on a contact record. Once accessed, your custom phone/calling UI will be displayed in an iframe at the specified URL with the specified dimensions on that record.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM cards

#Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM cards

#Allows an app to extend the CRM UI by surfacing custom cards in the sidebar of record pages. These cards are defined up-front as part of app configuration, then populated by external data fetch requests when the record page is accessed by a user.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Video Conference Extension

#These APIs allow you to specify URLs that can be used to interact with a video conferencing application, to allow HubSpot to add video conference links to meeting requests with contacts.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Video Conference Extension

#These APIs allow you to specify URLs that can be used to interact with a video conferencing application, to allow HubSpot to add video conference links to meeting requests with contacts.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Imports

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Imports

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Line Items

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Line Items

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Objects

#CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application. ## Supported Object Types This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview). |Object Type |Properties returned by default | |–|–| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` | Find a list of all properties for an object type using the [CRM Object Properties](developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Objects

#CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application. ## Supported Object Types This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview). |Object Type |Properties returned by default | |–|–| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` | Find a list of all properties for an object type using the [CRM Object Properties](developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Feedback Submissions

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Feedback Submissions

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Owners

#HubSpot uses owners to assign CRM objects to specific people in your organization. The endpoints described here are used to get a list of the owners that are available for an account. To assign an owner to an object, set the hubspot_owner_id property using the appropriate CRM object update or create a request. If teams are available for your HubSpot tier, these endpoints will also indicate which team an owner belongs to. Team membership can be one of PRIMARY (default), SECONDARY, or CHILD.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Owners

#HubSpot uses owners to assign CRM objects to specific people in your organization. The endpoints described here are used to get a list of the owners that are available for an account. To assign an owner to an object, set the hubspot_owner_id property using the appropriate CRM object update or create a request. If teams are available for your HubSpot tier, these endpoints will also indicate which team an owner belongs to. Team membership can be one of PRIMARY (default), SECONDARY, or CHILD.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Pipelines

#Pipelines represent distinct stages in a workflow, like closing a deal or servicing a support ticket. These endpoints provide access to read and modify pipelines in HubSpot. Pipelines support `deals` and `tickets` object types. ## Pipeline ID validation When calling endpoints that take pipelineId as a parameter, that ID must correspond to an existing, un-archived pipeline. Otherwise the request will fail with a `404 Not Found` response.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#CRM Pipelines

#Pipelines represent distinct stages in a workflow, like closing a deal or servicing a support ticket. These endpoints provide access to read and modify pipelines in HubSpot. Pipelines support `deals` and `tickets` object types. ## Pipeline ID validation When calling endpoints that take pipelineId as a parameter, that ID must correspond to an existing, un-archived pipeline. Otherwise the request will fail with a `404 Not Found` response.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Products

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Products

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Properties

#All HubSpot objects store data in default and custom properties. These endpoints provide access to read and modify object properties in HubSpot.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Properties

#All HubSpot objects store data in default and custom properties. These endpoints provide access to read and modify object properties in HubSpot.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Quotes

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Quotes

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Schemas

#The CRM uses schemas to define how custom objects should store and represent information in the HubSpot CRM. Schemas define details about an object's type, properties, and associations. The schema can be uniquely identified by its **object type ID**.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Schemas

#The CRM uses schemas to define how custom objects should store and represent information in the HubSpot CRM. Schemas define details about an object's type, properties, and associations. The schema can be uniquely identified by its **object type ID**.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Tickets

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Tickets

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Timeline events

#This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM objects like contacts, companies, tickets, or deals. You'll find multiple use cases for this API in the sections below.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Timeline events

#This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM objects like contacts, companies, tickets, or deals. You'll find multiple use cases for this API in the sections below.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#HubSpot Events API

#API for accessing CRM object events.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#HubSpot Events API

#API for accessing CRM object events.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Files

#Upload and manage files.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Files

#Upload and manage files.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Transactional Email

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Transactional Email

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#OAuthService

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#OAuthService

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Webhooks API

#Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the changes at a specified target URL. There can only be one target URL for receiving event notifications per app.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1

#Webhooks API

#Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the changes at a specified target URL. There can only be one target URL for receiving event notifications per app.

The version of the OpenAPI document: v3

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1