Hubspot API Integration Vol.1

Suggest Edits

These are the list of integration use cases supported by Knit for Hubspot API as part of the CRM category

Delete a Deal Object

ID: delete_a_deal_object
Operation: write
Entities: deal, error, object
Summary: This API endpoint deletes a deal object identified by the {dealId} and moves it to the recycling bin. It requires the 'crm.objects.deals.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. The response will be HTTP 204 with no content if successful. In case of an error, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a List by ILS List ID

ID: delete_a_list_by_ils_list_id
Operation: write
Entities: list, error
Summary: This API endpoint deletes a list by its ILS list ID. The list can be restored within 90 days of deletion. After 90 days, the list is permanently purged. The request requires an authorization header with a Bearer token and the listId as a path parameter. The response for a successful deletion is HTTP 204 with no content. In case of errors, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Pipeline

ID: delete_a_pipeline
Operation: write
Entities: deal, order, pipeline
Summary: This API deletes a pipeline identified by the pipelineId for a specified objectType. It requires authentication via a Bearer token. The API accepts path parameters for objectType and pipelineId, and optional query parameters to validate references and deal stage usages before deletion. The response is a 204 No Content on success, and an error object on failure, which includes details such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Schema

ID: delete_a_schema
Operation: delete
Entities: record, schema
Summary: The 'Delete a Schema' API endpoint allows you to delete a schema from the system. Before calling this API, ensure that any existing records of this schema are deleted, otherwise the call will fail. The API requires the fully qualified name or object type ID of the schema as a path parameter. It also accepts an optional query parameter 'archived' to specify whether to return only results that have been archived, with a default value of false. The response body is typically empty for a successful DELETE request.
Input Fields: Input Fields
Output Fields: Output Fields

Delete All Records from a List

ID: delete_all_records_from_a_list
Operation: write
Entities: list, membership, error
Summary: This API endpoint deletes all records from a specified list in the CRM. It does not delete the list itself, only the memberships within it. The endpoint is applicable only for lists with a processingType of MANUAL or SNAPSHOT and supports lists with fewer than 100,000 memberships. The request requires an authorization header with a Bearer token and a path parameter 'listId' which is the ILS ID of the list. The response is a 204 No Content status if successful. In case of errors, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Archive Meeting Object

ID: delete_archive_meeting_object
Operation: write
Entities: meeting, error, context
Summary: The Archive Meeting Object API allows you to move a meeting object identified by the meetingId to the recycling bin. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and the meetingId as a path parameter. A successful request returns a 204 No Content response. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive Note by ID

ID: delete_archive_note_by_id
Operation: write
Entities: error, note, context
Summary: This API endpoint archives a note identified by the {noteId} parameter by moving it to the recycling bin. It requires the 'crm.objects.contacts.write' scope for authorization. The request must include a valid Bearer token in the authorization header. The endpoint responds with a 204 No Content status on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Property

ID: delete_archive_property
Operation: write
Entities: property, error, objectType
Summary: The 'Archive a Property' API endpoint allows users to move a property identified by {propertyName} to the recycling bin. It requires the 'authorization' header with a Bearer token for authentication. The path parameters include 'objectType', which specifies the type of object the property belongs to, and 'propertyName', which is the name of the property to be archived. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and errors array with specific details about the error.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Property Group

ID: delete_archive_property_group
Operation: delete
Entities: property group, error, object type
Summary: This API endpoint is used to archive a property group identified by {groupName} by moving it to the recycling bin. It requires the objectType and groupName as path parameters. The request must include an authorization header with a Bearer token. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and errors array with specific error details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Association Definition

ID: delete_association_definition
Operation: delete
Entities: label, association, object type
Summary: This API deletes an association definition between two object types in the CRM. It requires the path parameters 'fromObjectType', 'toObjectType', and 'associationTypeId' to specify the association to be deleted. The request must include an 'authorization' header with a valid Bearer token. The API adheres to standard API rate limits and requires specific scopes for access. Upon successful deletion, the response body is empty.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Associations Between Two Records

ID: delete_associations_between_two_records
Operation: write
Entities: association, object, record
Summary: This API deletes all associations between two records specified by their object types and IDs. It requires authentication via a Bearer token. The path parameters include 'objectType', 'objectId', 'toObjectType', and 'toObjectId', which are all required. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Call Object

ID: delete_call_object
Operation: write
Entities: recycling bin, call, error
Summary: The Delete Call Object API moves a call object identified by the callId path parameter to the recycling bin. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. A successful request returns a 204 No Content response. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Calling Extension Settings

ID: delete_calling_extension_settings
Operation: write
Entities: account, setting, app
Summary: The Delete Calling Extension Settings API endpoint allows you to delete a calling extension. This will remove your service as an option for all connected accounts. The request requires the 'appId' as a path parameter, which is the ID of the app. The API key must be provided in the headers as 'hapikey'. The response will be HTTP 204 No Content if successful. In case of an error, the response will include details such as 'subCategory', 'context', 'correlationId', 'links', 'message', 'category', and 'errors' with specific error details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Card Definition

ID: delete_card_definition
Operation: write
Entities: error, app, card
Summary: This API permanently deletes a card definition with the given card ID from the specified app ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This action cannot be undone. The API requires the HubSpot developer API key as a header for authentication. The path parameters include 'appId' which is the ID of the target app, and 'cardId' which is the ID of the card to delete. The response for a successful deletion is HTTP 204 No Content. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with detailed information.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Cart Object

ID: delete_cart_object
Operation: write
Entities: cart, error, context
Summary: The Delete Cart Object API moves a cart object identified by the {cartId} path parameter to the recycling bin. It requires the 'crm.objects.carts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. A successful request returns a 204 No Content status. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Communication Object

ID: delete_communication_object
Operation: write
Entities: error, communication, context
Summary: This API endpoint is used to move a communication object identified by {communicationId} to the recycling bin. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include the 'authorization' header with a valid Bearer token. The path parameter 'communicationId' is required to specify the communication object to be archived. A successful request returns a 204 No Content response. In case of an error, the response includes details such as subCategory, context, correlationId, links, message, category, and errors array with specific error details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Company Object

ID: delete_company_object
Operation: write
Entities: company, error, context
Summary: This API endpoint is used to move a company object identified by {companyId} to the recycling bin. It requires the 'crm.objects.companies.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. The path parameter 'companyId' is required to specify the company to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Contact by ID

ID: delete_contact_by_id
Operation: write
Entities: recycling bin, contact, error
Summary: This API endpoint deletes a contact identified by the {contactId} from the CRM system and moves it to the recycling bin. It requires the 'crm.objects.contacts.write' scope for authorization. The request must include a valid Bearer token in the authorization header. The contactId is a required path parameter. On successful deletion, the API returns a 204 No Content response. In case of errors, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Delete CRM Folder

ID: delete_crm_folder
Operation: write
Entities: error, folder
Summary: This API endpoint deletes a folder in the CRM system using the specified folder ID. It requires the 'crm.lists.write' and 'crm.lists.read' scopes for authorization. The request must include the 'accept' and 'authorization' headers. The response will return an error object if the deletion fails, detailing the error category, message, and any missing scopes or invalid properties.
Input Fields: Input Fields
Output Fields: Output Fields

Delete CRM Object

ID: delete_crm_object
Operation: write
Entities: object
Summary: This API endpoint allows you to delete a CRM object identified by {objectId} and move it to the recycling bin. It requires authentication via a Bearer token. The path parameters include 'objectType' which specifies the type of the object, and 'objectId' which specifies the ID of the object to be deleted. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete CRM Object Schema

ID: delete_crm_object_schema
Operation: delete
Entities: schema, object type
Summary: The Delete CRM Object Schema API allows you to permanently delete a CRM object schema identified by the 'objectType' path parameter. This API does not require any specific scopes and is subject to standard API rate limits. The request is made using the DELETE method to the endpoint '/crm-object-schemas/v3/schemas/{objectType}/purge'. The 'objectType' path parameter is required and specifies the type of the object schema to be purged. The response body is typically empty upon a successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Discount Object

ID: delete_discount_object
Operation: write
Entities: discount, error, context
Summary: This API endpoint is used to move a discount object identified by {discountId} to the recycling bin. It requires an authorization header with a Bearer token for authentication. The {discountId} is a path parameter that specifies the discount object to be archived. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Email Object

ID: delete_email_object
Operation: write
Entities: email, error, context
Summary: This API endpoint deletes an email object identified by the {emailId} and moves it to the recycling bin. It requires authorization via a Bearer token. The request must include the emailId as a path parameter. On success, it returns a 204 No Content status. If there is an error, the response will include details about the error, such as a message, category, and context.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Event Template for App

ID: delete_event_template_for_app
Operation: write
Entities: event template, event
Summary: This API deletes an event template for a specified app. It requires the app ID and event template ID as path parameters. The API key must be provided in the headers. Upon successful deletion, all associated events will be removed from search results and the timeline UI. This action is irreversible, so it is recommended to stop using any associated events before deletion. The API returns a 204 No Content response on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Fee Object

ID: delete_fee_object
Operation: write
Entities: fee, error, object
Summary: The Delete Fee Object API moves a fee object identified by the {feeId} path parameter to the recycling bin. It requires an authorization header with a Bearer token. The API responds with a 204 No Content status on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Lead Object

ID: delete_lead_object
Operation: write
Entities: lead, error
Summary: This API endpoint is used to move a lead object identified by {leadsId} to the recycling bin. It requires the 'crm.objects.leads.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. The path parameter 'leadsId' is required to specify the lead to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Line Item

ID: delete_line_item
Operation: write
Entities: line item, error
Summary: The Delete Line Item API moves a line item identified by the {lineItemId} to the recycling bin. It requires an authorization header with a Bearer token for authentication. The lineItemId is a required path parameter that specifies the ID of the line item to be archived. The API returns a 204 No Content response on success. In case of an error, it returns a detailed error object containing information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Order Object

ID: delete_order_object
Operation: write
Entities: order, link, error
Summary: The Delete Order Object API allows you to move an order object identified by {orderId} to the recycling bin. It requires the 'crm.objects.orders.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. The path parameter 'orderId' is required to specify the order to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Pipeline Stage

ID: delete_pipeline_stage
Operation: write
Entities: error, stage, pipeline
Summary: This API deletes a pipeline stage identified by {stageId} associated with the pipeline identified by {pipelineId}. It requires authentication via a Bearer token. The path parameters include objectType, pipelineId, and stageId, all of which are required. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Postal Mail Object

ID: delete_postal_mail_object
Operation: write
Entities: postal mail, error, context
Summary: This API endpoint is used to move a postal mail object identified by the {postalMailId} to the recycling bin. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. The path parameter 'postalMailId' is required to specify the object to be archived. A successful request returns a 204 No Content response. In case of errors, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Product and Move to Recycling Bin

ID: delete_product_and_move_to_recycling_bin
Operation: write
Entities: error, product
Summary: This API endpoint allows you to delete a product identified by the {productId} and move it to the recycling bin. It requires an authorization header with a Bearer token. The path parameter 'productId' is required to specify which product to archive. On success, it returns a 204 No Content response. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and errors array with specific details about the error.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Quote Object

ID: delete_quote_object
Operation: write
Entities: quote, error, authentication
Summary: The Delete Quote Object API allows you to move a quote object identified by {quoteId} to the recycling bin. It requires an authorization header with a Bearer token. The path parameter 'quoteId' is required to specify the quote to be deleted. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Remove an Association from a Schema

ID: delete_remove_association_from_schema
Operation: write
Entities: association, schema
Summary: The 'Remove an Association from a Schema' API endpoint allows users to delete an existing association from a specified schema. The request requires two path parameters: 'objectType', which is the fully qualified name or object type ID of the schema, and 'associationIdentifier', which is the unique ID of the association to be removed. The API does not require any specific headers, query parameters, or request body. Upon successful execution, the association will be removed, and the response will not contain any body content.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Token from Event Template

ID: delete_remove_token_from_event_template
Operation: write
Entities: token, app, event template
Summary: This API endpoint removes a token from an existing event template in the HubSpot integrators timeline. It requires the app ID, event template ID, and token name as path parameters. Once a token is removed, existing events and CRM objects will retain the token and its mapped object properties, but new ones will not. The timeline will still display this property for older CRM objects if it's still referenced in the template Markdown. The API returns a 204 No Content response on success. In case of errors, it provides detailed error information including a unique correlation ID, error category, and human-readable messages.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Task Object

ID: delete_task_object
Operation: write
Entities: task, error, context
Summary: The Delete Task Object API moves a task object identified by the {taskId} to the recycling bin. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. The path parameter 'taskId' is required to specify the task to be deleted. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Tax Object

ID: delete_tax_object
Operation: write
Entities: tax
Summary: The Delete Tax Object API endpoint allows you to move a tax object identified by {taxId} to the recycling bin. It requires the 'crm.objects.line_items.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token. The path parameter 'taxId' is required to specify the tax object to be deleted. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket and Move to Recycling Bin

ID: delete_ticket_and_move_to_recycling_bin
Operation: write
Entities: link, error, ticket
Summary: This API endpoint allows you to delete a ticket identified by {ticketId} and move it to the recycling bin. It requires an authorization header with a Bearer token. The path parameter 'ticketId' is required to specify which ticket to delete. The API returns a 204 No Content response on success. In case of an error, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Video Conference Application Settings

ID: delete_video_conference_application_settings
Operation: write
Entities: setting, error, video conference application
Summary: This API deletes the settings for a video conference application with the specified ID. It requires the 'appId' as a path parameter, which is the identifier of the application created in your HubSpot developer portal. The request must include the HubSpot developer API key in the headers for authentication. The API returns a 204 No Content response on successful deletion. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Page of CRM Owners

ID: get_a_page_of_crm_owners
Operation: read
Entities: team, owner
Summary: This API endpoint retrieves a page of CRM owners. It supports filtering by email, pagination using a cursor token, and limiting the number of results per page. The response includes details about each owner, such as their name, email, creation and update timestamps, and team affiliations. The API requires an authorization bearer token and supports optional query parameters for filtering and pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Get Active Imports

ID: get_active_imports
Operation: read
Entities: account, import, error
Summary: The 'Get Active Imports' API endpoint retrieves a paged list of active imports for a HubSpot account. It requires an authorization header with a Bearer token. The API supports query parameters such as 'after', 'before', and 'limit' to manage pagination. The response includes details about each import, such as the import template, creation and update timestamps, metadata about the import process, and the state of the import. The API returns a 200 status code for successful operations and provides detailed error messages for validation errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Cards for a Given App

ID: get_all_cards_for_a_given_app
Operation: read
Entities: display, fetch, card
Summary: This API endpoint retrieves a list of cards for a specified app using the app's ID. The request requires the appId as a path parameter and the HubSpot developer API key as a header. The response includes details about each card, such as its ID, creation and update timestamps, title, fetch configuration, display properties, and actions. The API does not require any specific scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get All CRM Object Schemas

ID: get_all_crm_object_schemas
Operation: read
Entities: property, association, schema
Summary: This API endpoint retrieves all CRM object schemas defined for your account. It requires an authorization bearer token and supports an optional query parameter 'archived' to filter results based on their archived status. The response includes detailed information about each schema, such as associations, properties, labels, and metadata. The API returns a list of schemas with their unique IDs, names, and other attributes, allowing you to manage and understand the structure of your CRM data.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Pipelines for a Specified Object Type

ID: get_all_pipelines_for_object_type
Operation: read
Entities: metadata, pipeline stage, pipeline
Summary: This API endpoint retrieves all pipelines for a specified object type in HubSpot. The object type is specified as a path parameter. The API requires an authorization header with a Bearer token. The response includes details about each pipeline, such as creation date, archived status, display order, and stages within the pipeline. Each stage includes metadata, display order, permissions, label, and unique identifiers. The API supports various scopes for access control and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get All User Configurations

ID: get_all_user_configurations
Operation: read
Entities: user, configuration, portal
Summary: This API endpoint retrieves all user configurations available on a given portal. It requires an authorization header with a Bearer token. The response includes an array of configuration objects, each containing details such as userEnforcedMaxToObjectIds, typeId, label, and category. The API supports various scopes for access control and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get All User Configurations for a Portal

ID: get_all_user_configurations_for_a_portal
Operation: read
Entities: user configuration, portal, scope
Summary: This API endpoint retrieves all user configurations available on a given portal. It requires authentication via a Bearer token and supports various scopes for access. The response includes an array of configuration objects, each with properties such as 'userEnforcedMaxToObjectIds', 'typeId', 'label', and 'category'. In case of an error, a detailed error object is returned, which includes information such as 'subCategory', 'context', 'correlationId', 'links', 'message', and 'category'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Association Types Between Object Types

ID: get_association_types_between_object_types
Operation: read
Entities: label, association type, object type
Summary: This API endpoint retrieves all association types between two specified object types in the CRM. It requires an authorization header with a bearer token. The path parameters 'fromObjectType' and 'toObjectType' specify the object types for which the association types are to be retrieved. The response includes an array of association types, each with a typeId, label, and category. In case of an error, detailed error information is provided, including a correlationId for support purposes.
Input Fields: Input Fields
Output Fields: Output Fields

Get Audit of Pipeline Stage Changes

ID: get_audit_of_pipeline_stage_changes
Operation: read
Entities: pipeline, stage, audit
Summary: This API endpoint returns an audit of all changes to a specified pipeline stage. It provides a reverse chronological list of all mutations that have occurred on the pipeline stage identified by the 'stageId'. The request requires an authorization header with a Bearer token and path parameters including 'objectType', 'pipelineId', and 'stageId'. The response includes details of each change such as the identifier, raw object data, user ID, portal ID, action, message, and timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Get Call Object Details

ID: get_call_object_details
Operation: read
Entities: property, association, call
Summary: This API endpoint retrieves details of a call object identified by the callId. The callId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties and propertiesWithHistory query parameters. It also supports retrieving associated object IDs using the associations query parameter. The archived query parameter can be used to filter archived results. The response includes details such as associations, creation and update timestamps, properties, and their history.
Input Fields: Input Fields
Output Fields: Output Fields

Get Calling Extension Settings

ID: get_calling_extension_settings
Operation: read
Entities: calling setting, error, extension
Summary: This API endpoint retrieves the calling extension settings configured for a specific app in HubSpot. It requires the app ID as a path parameter and the HubSpot developer API key as a query parameter. The response includes details such as the creation and update timestamps, compatibility with custom objects, readiness status, service name, iframe dimensions, and the URL for the calling UI. The API adheres to standard rate limits and does not require any specific scopes.
Input Fields: Input Fields
Output Fields: Output Fields

Get Card Definition by ID

ID: get_card_definition_by_id
Operation: read
Entities: error, app, card
Summary: This API endpoint retrieves the definition of a card by its ID. It requires the app ID and card ID as path parameters, and the HubSpot developer API key as a query parameter. The response includes details such as the creation and update timestamps, title, fetch configuration, display properties, and actions configuration of the card. The API adheres to standard rate limits and does not require any specific scopes.
Input Fields: Input Fields
Output Fields: Output Fields

Get Cart Details by Cart ID

ID: get_cart_details_by_cart_id
Operation: read
Entities: cart, association, property
Summary: This API endpoint retrieves the details of a cart identified by the {cartId}. The {cartId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows you to control the returned data via the properties query parameter, which is a list of properties to be included in the response. Additionally, you can request properties with their history, associated object types, and specify whether to include archived results. The response includes details such as the cart's properties, associations, creation and update timestamps, and archived status. The API requires an authorization header with a Bearer token and supports OAuth and private apps for authentication.
Input Fields: Input Fields
Output Fields: Output Fields

Get Commerce Payment Details

ID: get_commerce_payment_details
Operation: read
Entities: property, association, commerce payment
Summary: This API endpoint retrieves details of a commerce payment object identified by the {commercePaymentId}. The {commercePaymentId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties and propertiesWithHistory query parameters. Additionally, associated object types can be retrieved using the associations query parameter. The archived query parameter can be used to filter archived results. The response includes details such as associations, creation and update timestamps, properties, and their history.
Input Fields: Input Fields
Output Fields: Output Fields

Get Communication Details by ID

ID: get_communication_details_by_id
Operation: read
Entities: property, association, communication
Summary: This API endpoint retrieves details of a communication object identified by the communicationId. The communicationId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with the propertiesWithHistory parameter. Associations can be retrieved using the associations parameter. The archived parameter determines if only archived results are returned, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Company Details by ID

ID: get_company_details_by_id
Operation: read
Entities: property, association, company
Summary: This API endpoint retrieves details of a company identified by the {companyId}. The {companyId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can also return properties with their history using the propertiesWithHistory query parameter. Additionally, it can retrieve associated object IDs using the associations query parameter and filter archived results using the archived query parameter. The response includes details such as the company's properties, associations, creation and update timestamps, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Contact Details by Contact ID

ID: get_contact_details_by_contact_id
Operation: read
Entities: contact
Summary: This API endpoint retrieves the details of a contact identified by the contactId. The contactId is the internal object ID of the contact. The API allows you to specify which properties to return using the properties query parameter. You can also request properties with their history using the propertiesWithHistory parameter, and retrieve associated object IDs using the associations parameter. The archived parameter allows you to filter results to only include archived contacts. The response includes the contact's properties, associations, creation and update timestamps, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Read CRM Object by ID

ID: get_crm_object_by_id
Operation: read
Entities: property, association, object
Summary: This API endpoint allows you to read a CRM object identified by its objectId. The objectId can refer to the internal object ID or any unique property value specified by the idProperty query parameter. You can control the response by specifying which properties to return using the properties query parameter. The endpoint supports various scopes for access control and adheres to standard API rate limits. The response includes details about the object, its properties, associations, and timestamps for creation and updates.
Input Fields: Input Fields
Output Fields: Output Fields

Get Deal Details by Deal ID

ID: get_deal_details_by_deal_id
Operation: read
Entities: property, association, deal
Summary: This API endpoint retrieves details of a deal identified by the specified dealId. The dealId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can also return properties with their history using the propertiesWithHistory query parameter. Additionally, associated object types can be retrieved using the associations query parameter. The archived query parameter controls whether only archived results are returned, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Discount Details

ID: get_discount_details
Operation: read
Entities: discount, line item, property
Summary: This API endpoint retrieves details of a discount object identified by the {discountId}. The {discountId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with propertiesWithHistory. It also supports retrieving associated object IDs with the associations parameter and can filter archived results using the archived parameter. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Email Object Details

ID: get_email_object_details
Operation: read
Entities: property, association, email
Summary: This API endpoint retrieves details of an email object identified by the {emailId}. The {emailId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with propertiesWithHistory. Associations with other objects can be retrieved using the associations query parameter. The archived query parameter determines if only archived results are returned, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Event Detail Template Rendered

ID: get_event_detail_template_rendered
Operation: read
Entities: template, error, event
Summary: This API endpoint retrieves the detailTemplate as rendered for a specified event. It requires the eventTemplateId and eventId as path parameters. The API uses OAuth for authentication and requires specific scopes such as 'tickets' or 'timeline'. The response includes the rendered details in HTML format. If there are errors, the response will include detailed error information including missing scopes, invalid property names, and a correlation ID for support.
Input Fields: Input Fields
Output Fields: Output Fields

Get Event Details

ID: get_event_details
Operation: read
Entities: template, contact, event
Summary: This API endpoint retrieves the details of a previously created event using the event template ID and event ID. It requires authorization via a Bearer token. The response includes comprehensive details about the event, such as the event template ID, creation time, additional data, iframe details, domain, tokens, unique identifier, user token, email, CRM object ID, timestamp, and object type. The API requires specific scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Existing CRM Object Schema

ID: get_existing_crm_object_schema
Operation: read
Entities: property, association, schema
Summary: This API retrieves an existing CRM object schema from HubSpot. It requires the 'crm.objects.custom.read' or 'crm.schemas.custom.read' scope for authorization. The request must include the 'authorization' header with a Bearer token and a path parameter 'objectType' which is the fully qualified name or object type ID of the schema. The response includes details about the object schema such as associations, properties, labels, and metadata. The response body provides comprehensive information about the schema, including its creation and update timestamps, properties, and associations.
Input Fields: Input Fields
Output Fields: Output Fields

Get Export Task Status

ID: get_export_task_status
Operation: read
Entities: task, error, export
Summary: This API endpoint retrieves the status of an export task identified by the taskId. It returns the status of the export, including the URL of the resulting file if the export status is COMPLETE. The request requires an authorization header with a Bearer token. The response includes details such as the result, timestamps for when the export was requested, started, and completed, the number of errors, and any related links. If there are errors, detailed information about each error is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get Fee Object Details

ID: get_fee_object_details
Operation: read
Entities: property, association, fee
Summary: This API endpoint retrieves details of a fee object identified by the {feeId}. The {feeId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties and propertiesWithHistory query parameters. It also supports retrieving associated object IDs using the associations query parameter. The archived query parameter can be used to filter archived results. The response includes details such as associations, creation and update timestamps, properties, and their history.
Input Fields: Input Fields
Output Fields: Output Fields

Get Feedback Submission Details

ID: get_feedback_submission_details
Operation: read
Entities: property, association, feedback submission
Summary: This API endpoint retrieves details of a feedback submission identified by the feedbackSubmissionId. The feedbackSubmissionId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows control over the returned data via query parameters such as properties, propertiesWithHistory, associations, archived, and idProperty. The response includes details like associations, creation and update timestamps, properties, and archived status. The API requires authorization via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Get Feedback Submissions

ID: get_feedback_submissions
Operation: read
Entities: property, association, feedback submission
Summary: This API endpoint retrieves a page of feedback submissions from the CRM. It allows filtering and control over the returned data through various query parameters such as 'limit', 'after', 'properties', 'propertiesWithHistory', 'associations', and 'archived'. The 'limit' parameter controls the number of results per page, while 'after' is used for pagination. 'Properties' and 'propertiesWithHistory' allow specifying which properties to return, with the latter including historical values. 'Associations' retrieves associated object IDs, and 'archived' filters results based on their archived status. The response includes paging information and a list of feedback submissions with details like creation and update timestamps, properties, and associations.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch List by ID

ID: get_fetch_list_by_id
Operation: read
Entities: list, filter branch, user
Summary: The Fetch List by ID API allows you to retrieve a single list by its ILS list ID. It requires the 'crm.lists.read' scope and adheres to standard API rate limits. The API takes a path parameter 'listId' which is the ILS ID of the list to fetch. Optionally, a query parameter 'includeFilters' can be set to true to include filter branch definitions in the response. The response includes detailed information about the list such as processing type, object type, creation and update timestamps, and filter branches. In case of errors, detailed error messages and context are provided.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch List by Name

ID: get_fetch_list_by_name
Operation: read
Entities: list, filter branch, filter
Summary: The 'Fetch List by Name' API endpoint allows users to retrieve a single list by specifying the list name and object type ID. The endpoint requires authentication via a Bearer token and supports OAuth. The path parameters include 'objectTypeId' and 'listName', which are required to identify the list. An optional query parameter 'includeFilters' can be set to true to include filter branch definitions in the response. The response includes detailed information about the list, such as processing type, object type ID, list ID, creation and update timestamps, and filter branch details. The API adheres to standard rate limits and requires the 'crm.lists.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch List Memberships Ordered by ID

ID: get_fetch_list_memberships_ordered_by_id
Operation: read
Entities: list, membership, record
Summary: This API endpoint fetches the memberships of a list ordered by the recordId of the records in the list. The records are sorted in ascending order if an 'after' offset or no offset is provided. If only a 'before' offset is provided, the records are sorted in descending order. The 'after' offset takes precedence over the 'before' offset if both are provided. The API requires the 'listId' as a path parameter and supports optional query parameters 'after', 'before', and 'limit' to control pagination and the number of records returned. The response includes the total number of records, paging information, and a list of results with each record's ID and membership timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch Multiple Lists by ILS List ID

ID: get_fetch_multiple_lists_by_ils_list_id
Operation: read
Entities: list, user, filter
Summary: This API endpoint allows you to fetch multiple lists by their ILS list IDs in a single request. The response includes the definitions of all lists that exist for the provided list IDs. You can optionally include filter branch definitions in the response by setting the 'includeFilters' query parameter to true. The request requires an authorization header with a Bearer token. The response contains detailed information about each list, including processing type, object type, creation and update timestamps, and filter branch details.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Folder with Child Nodes

ID: get_folder_with_child_nodes
Operation: read
Entities: child list, child node, folder
Summary: This API retrieves a folder from the CRM system, including all its child folders recursively via the childNodes attribute. The child lists field will be empty in all child nodes, and only the folder retrieved will include the child lists in that folder. The request requires an authorization header with a Bearer token and accepts a query parameter 'folderId' to specify the folder to retrieve. The response includes details about the folder such as its creation and update timestamps, parent folder ID, child nodes, and user ID. In case of an error, a detailed error message is provided with information about missing scopes or invalid properties.
Input Fields: Input Fields
Output Fields: Output Fields

Read Goal Target Object

ID: get_goal_target_object
Operation: read
Entities: property, association, goal target
Summary: This API endpoint allows you to read a Goal Target object identified by the goalTargetId. The goalTargetId can be the internal object ID or any unique property value specified by the idProperty query parameter. You can control the response by specifying properties, propertiesWithHistory, and associations as query parameters. The archived query parameter allows you to filter for archived results. The response includes details about the object such as its properties, associations, creation and update timestamps, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Import Errors

ID: get_import_errors
Operation: read
Entities: import, error, source data
Summary: The Get Import Errors API retrieves errors associated with a specific import in HubSpot. It requires an import ID as a path parameter and supports optional query parameters for pagination, such as 'after' for the paging cursor token and 'limit' for the maximum number of results per page. The response includes a list of errors with details such as the error type, context, and source data. Authentication is required via a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Get Import Information

ID: get_import_information
Operation: read
Entities: metadata, import, error
Summary: This API endpoint retrieves detailed information about a specific import in HubSpot. It requires the import ID as a path parameter and an authorization bearer token in the headers. The response includes a comprehensive summary of the import record, such as the import template details, creation and update timestamps, metadata about the import process, the source and name of the import, its current state, and whether it is an opt-out import. The API is subject to standard rate limits and requires the 'crm.import' scope for access.
Input Fields: Input Fields
Output Fields: Output Fields

Get Invoice Details

ID: get_invoice_details
Operation: read
Entities: property, association, invoice
Summary: This API endpoint retrieves details of an invoice identified by the {invoiceId}. The {invoiceId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can also return properties with their history using the propertiesWithHistory query parameter. Associations can be retrieved using the associations query parameter. The archived query parameter determines if only archived results should be returned. The response includes details such as associations, creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Lead Details by ID

ID: get_lead_details_by_id
Operation: read
Entities: lead, association, property
Summary: This API endpoint retrieves details of a lead identified by the {leadsId}. The {leadsId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with propertiesWithHistory. It also supports retrieving associated object IDs with the associations parameter and can filter archived results using the archived parameter. The response includes lead details such as associations, creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Line Item Details

ID: get_line_item_details
Operation: read
Entities: property, association, line item
Summary: This API endpoint retrieves details of a line item identified by the lineItemId. The lineItemId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can also return properties with their history using the propertiesWithHistory parameter. Associations can be retrieved using the associations parameter. The archived parameter specifies whether to return only archived results, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

List All Associations of an Object by Object Type

ID: get_list_all_associations_of_an_object_by_object_type
Operation: read
Entities: type, association, object
Summary: This API endpoint retrieves a list of all associations for a specified object by its type. It requires the object type, object ID, and the type of the associated object as path parameters. The API supports pagination with a 'limit' query parameter (default 500) and an 'after' query parameter for cursor-based pagination. The response includes a list of associations with details such as type ID, label, and category, along with the ID of the associated object. The API requires authorization via a Bearer token and supports various scopes for access control.
Input Fields: Input Fields
Output Fields: Output Fields

List All Event Templates for an App

ID: get_list_all_event_templates_for_an_app
Operation: read
Entities: CRM object, token, event template
Summary: This API endpoint is used to list all event templates owned by a specific app in HubSpot. The request requires the app ID as a path parameter and the HubSpot developer API key as a header. The response includes a list of event templates, each with details such as template ID, object type, name, header template, detail template, creation and update timestamps, and associated tokens. Tokens include information like name, type, creation and update timestamps, label, object property name, and options. The API supports standard rate limits and does not require any specific scopes.
Input Fields: Input Fields
Output Fields: Output Fields

List Commerce Payments

ID: get_list_commerce_payments
Operation: read
Entities: property, association, commerce payment
Summary: This API endpoint retrieves a paginated list of commerce payments. The response can be controlled using query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, and 'properties' to specify which properties to return. The response includes details about each payment, such as its associations, creation and update timestamps, and properties. Authentication is required via a Bearer token. The API supports OAuth and private apps, and requires the 'crm.objects.commercepayments.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

List Line Items

ID: get_list_line_items
Operation: read
Entities: property, association, line item
Summary: This API endpoint retrieves a page of line items from the CRM. It allows control over the returned data via query parameters such as 'limit', 'after', 'properties', 'propertiesWithHistory', 'associations', and 'archived'. The 'limit' parameter specifies the maximum number of results per page, defaulting to 10. The 'after' parameter is used for pagination. 'Properties' and 'propertiesWithHistory' allow specifying which properties to return, with the latter including historical values. 'Associations' retrieves associated object IDs, and 'archived' filters for archived items. The response includes paging information and a list of line items with their details.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch List Memberships Ordered by Added to List Date

ID: get_list_memberships_ordered_by_added_date
Operation: read
Entities: list, membership, record
Summary: This API endpoint fetches the memberships of a list ordered by the time the records were added to the list. The records can be paginated using 'after' and 'before' query parameters. The 'after' parameter takes precedence if both 'after' and 'before' are provided. The 'limit' parameter specifies the number of records to return, with a default of 100 and a maximum of 250. The response includes the total number of records, paging information, and a list of results with each record's ID and membership timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Get Lists Record is Member Of

ID: get_lists_record_is_member_of
Operation: read
Entities: list, membership, record
Summary: This API endpoint retrieves the lists that a given record is a member of. It requires the object type ID and record ID as path parameters. The request must include an authorization header with a Bearer token. The response includes the total number of lists and details about each list, such as the list ID, version, and timestamps of when the record was added. The API requires the 'crm.lists.read' scope and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Meeting Details by Meeting ID

ID: get_meeting_details_by_meeting_id
Operation: read
Entities: property, association, meeting
Summary: This API endpoint retrieves details of a meeting object identified by the meetingId. The meetingId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can also return properties with their history using the propertiesWithHistory parameter. Additionally, associated object types can be retrieved using the associations parameter. The archived parameter determines if only archived results should be returned, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Read Note Object by ID

ID: get_note_object_by_id
Operation: read
Entities: property, association, note
Summary: This API endpoint allows you to read a Note object identified by {noteId}. The {noteId} can be the internal object ID or any unique property value specified by the idProperty query parameter. You can control the response by specifying which properties to return using the properties query parameter. Additionally, you can request properties with their history, associated object types, and whether to include archived results. The response includes details about the note's associations, properties, creation and update timestamps, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Read Order Object by ID

ID: get_order_object_by_id
Operation: read
Entities: property, association, order
Summary: This API endpoint retrieves an order object identified by the specified orderId. The orderId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows control over the returned data via the properties query parameter, which specifies a list of properties to be included in the response. Additionally, propertiesWithHistory can be used to retrieve properties along with their historical values, and associations can be used to retrieve associated object IDs. The archived query parameter determines whether to return only archived results, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Goal Targets

ID: get_page_of_goal_targets
Operation: read
Entities: property, association, goal target
Summary: This API endpoint allows you to read a page of goal targets from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of goal target objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Get Pipeline Audit

ID: get_pipeline_audit
Operation: read
Entities: mutation, pipeline, audit
Summary: The Get Pipeline Audit API returns a reverse chronological list of all mutations that have occurred on the specified pipeline. It requires the objectType and pipelineId as path parameters and an authorization header with a Bearer token. The response includes details of each change, such as the identifier, raw object data, user ID, portal ID, action, message, and timestamp. The API supports various scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Pipeline by ID

ID: get_pipeline_by_id
Operation: read
Entities: stage, pipeline
Summary: This API endpoint retrieves a single pipeline object identified by its unique pipelineId. It requires authentication via a Bearer token. The request must include the objectType and pipelineId as path parameters. The response includes details about the pipeline such as its creation date, archived status, display order, stages, and labels. Each stage within the pipeline also includes metadata, display order, permissions, and other relevant details. The API supports various scopes for access control and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Pipeline Stage by ID

ID: get_pipeline_stage_by_id
Operation: read
Entities: error, stage, pipeline
Summary: This API endpoint retrieves a specific pipeline stage by its ID. It requires the object type, pipeline ID, and stage ID as path parameters. The request must include an authorization header with a Bearer token. The response includes details about the pipeline stage such as creation date, archived status, metadata, display order, permissions, label, unique ID, and last updated date. The API supports various scopes for access control and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Pipeline Stages

ID: get_pipeline_stages
Operation: read
Entities: error, stage, pipeline
Summary: This API endpoint retrieves all stages associated with a specified pipeline identified by the pipelineId. It requires an authorization bearer token and the objectType and pipelineId as path parameters. The response includes details about each stage, such as creation date, archived status, metadata, display order, permissions, label, unique ID, and last updated date. The API supports various scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Postal Mail Object Details

ID: get_postal_mail_object_details
Operation: read
Entities: property, association, postal mail
Summary: This API endpoint retrieves details of a postal mail object identified by the postalMailId. The postalMailId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with propertiesWithHistory. Associations with other object types can be retrieved using the associations query parameter. The archived query parameter determines if only archived results are returned, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Product Details by Product ID

ID: get_product_details_by_product_id
Operation: read
Entities: property, association, product
Summary: This API endpoint retrieves details of a product identified by the productId. The productId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter, and can also return properties with their history using the propertiesWithHistory parameter. Associations with other objects can be retrieved using the associations parameter. The archived parameter specifies whether to return only archived results. The response includes details such as associations, creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Quote Details by Quote ID

ID: get_quote_details_by_quote_id
Operation: read
Entities: property, association, quote
Summary: This API endpoint retrieves details of a quote identified by the {quoteId}. The {quoteId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with propertiesWithHistory. It also supports retrieving associated object IDs with the associations parameter and can filter archived results using the archived parameter. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Calls

ID: get_read_a_page_of_calls
Operation: read
Entities: property, association, call
Summary: This API endpoint allows you to read a page of call records from the CRM. You can control the data returned using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of call objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Carts

ID: get_read_a_page_of_carts
Operation: read
Entities: cart, association, property
Summary: This API endpoint allows you to read a page of carts from the CRM. You can control the results returned using various query parameters such as 'limit', 'after', 'properties', 'propertiesWithHistory', 'associations', and 'archived'. The 'limit' parameter specifies the maximum number of results per page, defaulting to 10. The 'after' parameter is used for pagination. The 'properties' and 'propertiesWithHistory' parameters allow you to specify which properties to return, with the latter also including historical values. The 'associations' parameter lets you retrieve associated object IDs. The 'archived' parameter filters results based on their archived status, defaulting to false. The response includes paging information and a list of cart objects with their details.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Communications

ID: get_read_a_page_of_communications
Operation: read
Entities: property, association, communication
Summary: This API endpoint allows you to read a page of communications from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of communication objects with their details.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Companies

ID: get_read_a_page_of_companies
Operation: read
Entities: property, association, company
Summary: This API endpoint retrieves a page of companies from the CRM. It allows for control over the returned data via query parameters such as 'limit', 'after', 'properties', 'propertiesWithHistory', 'associations', and 'archived'. The 'limit' parameter controls the number of results per page, defaulting to 10. The 'after' parameter is used for pagination. The 'properties' and 'propertiesWithHistory' parameters specify which properties to return, with the latter including historical values. The 'associations' parameter retrieves associated object IDs, and 'archived' filters for archived results. The response includes paging information and a list of company objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Contacts

ID: get_read_a_page_of_contacts
Operation: read
Entities: contact
Summary: This API endpoint allows you to read a page of contacts from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of contact objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of CRM Objects

ID: get_read_a_page_of_crm_objects
Operation: read
Entities: property, association, object
Summary: This API endpoint allows you to read a page of CRM objects from HubSpot. You can control the data returned by specifying various query parameters such as 'limit' for the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of results with details such as associations, creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Deals

ID: get_read_a_page_of_deals
Operation: read
Entities: property, association, deal
Summary: This API endpoint allows you to read a page of deals from the CRM. You can control the data returned by specifying query parameters such as 'limit' for the number of results per page, 'after' for pagination, 'properties' to specify which deal properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived deals. The response includes paging information and a list of deal objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Discounts

ID: get_read_a_page_of_discounts
Operation: read
Entities: discount, association, property
Summary: This API endpoint allows you to read a page of discounts from the CRM. You can control the data returned using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of discount objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Emails

ID: get_read_a_page_of_emails
Operation: read
Entities: property, association, email
Summary: This API endpoint allows you to read a page of emails from the CRM. You can control the results returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of email objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Fees

ID: get_read_a_page_of_fees
Operation: read
Entities: property, association, fee
Summary: This API endpoint allows you to read a page of fees from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of fee objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Invoices

ID: get_read_a_page_of_invoices
Operation: read
Entities: property, association, invoice
Summary: This API endpoint allows you to read a page of invoices from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of invoice objects with their properties, associations, and timestamps. The API requires an authorization header with a Bearer token.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Leads

ID: get_read_a_page_of_leads
Operation: read
Entities: lead, association, property
Summary: This API endpoint allows you to read a page of leads from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of lead objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Meetings

ID: get_read_a_page_of_meetings
Operation: read
Entities: property, association, meeting
Summary: This API endpoint allows you to read a page of meetings from the CRM. You can control the data returned using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of meeting objects with their properties, associations, and timestamps. The API requires an authorization header with a Bearer token and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Notes

ID: get_read_a_page_of_notes
Operation: read
Entities: property, association, note
Summary: This API endpoint allows you to read a page of notes from the CRM. You can control the data returned using various query parameters such as 'limit', 'after', 'properties', 'propertiesWithHistory', 'associations', and 'archived'. The 'limit' parameter specifies the maximum number of results per page, defaulting to 10. The 'after' parameter is used for pagination. The 'properties' and 'propertiesWithHistory' parameters allow you to specify which properties to return, with the latter also including historical values. The 'associations' parameter retrieves associated object IDs, and the 'archived' parameter filters results based on their archived status. The response includes paging information and a list of note objects with their details.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Orders

ID: get_read_a_page_of_orders
Operation: read
Entities: property, association, order
Summary: This API endpoint allows you to read a page of orders from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of order objects with their details.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Postal Mail

ID: get_read_a_page_of_postal_mail
Operation: read
Entities: property, association, postal mail
Summary: This API endpoint allows you to read a page of postal mail objects from the CRM. You can control the data returned by specifying query parameters such as 'limit' for the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of postal mail objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Products

ID: get_read_a_page_of_products
Operation: read
Entities: property, association, product
Summary: This API endpoint allows you to read a page of products from the CRM. You can control the results returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which product properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived products. The response includes paging information and a list of product results with details such as creation and update timestamps, properties, and associations.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Quotes

ID: get_read_a_page_of_quotes
Operation: read
Entities: property, association, quote
Summary: This API endpoint allows you to read a page of quotes from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of quote objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Subscriptions

ID: get_read_a_page_of_subscriptions
Operation: read
Entities: property, association, subscription
Summary: This API endpoint allows you to read a page of subscriptions from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of subscription objects with their details.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Tasks

ID: get_read_a_page_of_tasks
Operation: read
Entities: property, association, task
Summary: This API endpoint allows you to read a page of tasks from the CRM. You can control the results returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include property history, 'associations' to retrieve associated object IDs, and 'archived' to filter archived tasks. The response includes paging information and a list of task objects with their properties, associations, and timestamps. The API requires an authorization header with a Bearer token and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Taxes

ID: get_read_a_page_of_taxes
Operation: read
Entities: property, tax, association
Summary: This API endpoint allows you to read a page of taxes from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values, 'associations' to retrieve associated object IDs, and 'archived' to filter archived results. The response includes paging information and a list of tax objects with their properties, associations, and history if requested.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Page of Tickets

ID: get_read_a_page_of_tickets
Operation: read
Entities: property, association, ticket
Summary: This API endpoint allows you to read a page of tickets from the CRM. You can control the data returned by using various query parameters such as 'limit' to specify the number of results per page, 'after' for pagination, 'properties' to specify which properties to return, 'propertiesWithHistory' to include historical values of properties, 'associations' to retrieve associated object IDs, and 'archived' to filter archived tickets. The response includes paging information and a list of ticket objects with their properties, associations, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Property

ID: get_read_a_property
Operation: read
Entities: property, metadata, option
Summary: This API endpoint allows you to read a property identified by {propertyName} for a specified {objectType} in HubSpot. It requires authentication via a Bearer token and supports various scopes for access. The endpoint accepts path parameters for objectType and propertyName, and optional query parameters such as archived and properties. The response includes detailed information about the property, including its creation and update metadata, display settings, and options. The API adheres to standard rate limits and provides detailed error messages in case of validation errors.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Property Group

ID: get_read_a_property_group
Operation: read
Entities: property, error, property group
Summary: This API endpoint allows you to read a property group identified by {groupName} for a specified {objectType}. It requires an authorization header with a Bearer token. The response includes details about the property group such as whether it is archived, its internal name, display order, and label. The API requires specific scopes for access and adheres to standard API rate limits. In case of errors, detailed error information is provided including subcategories, context, and links to documentation.
Input Fields: Input Fields
Output Fields: Output Fields

Read All Properties for Specified Object Type in HubSpot

ID: get_read_all_properties_for_specified_object_type
Operation: read
Entities: property, option, modification metadata
Summary: This API endpoint allows you to read all existing properties for a specified object type in a HubSpot account. It requires authentication via a Bearer token and supports both private apps and OAuth. The endpoint accepts a path parameter 'objectType' to specify the type of object for which properties are being requested. It also supports query parameters such as 'archived' to filter archived properties and 'properties' to specify a list of property names to include in the response. The response includes detailed information about each property, such as its creation and update metadata, visibility, data type, and options. The API requires specific scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read All Property Groups for Specified Object Type

ID: get_read_all_property_groups
Operation: read
Entities: object type, property group, HubSpot account
Summary: This API endpoint allows you to read all existing property groups for a specified object type in a HubSpot account. It requires an authorization header with a Bearer token. The path parameter 'objectType' specifies the type of object for which property groups are being retrieved. The response includes an array of property groups, each with details such as whether it is archived, its internal name, display order, and label. The API requires specific scopes for access, and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read Calling App Recording Settings

ID: get_read_calling_app_recording_settings
Operation: read
Entities: recording, error, setting
Summary: This API retrieves the recording endpoint configured for a calling extension app in HubSpot. It requires the app ID as a path parameter and the HubSpot developer API key as a query parameter. The response includes the URL to retrieve the authenticated recording. In case of an error, detailed error information is provided, including a unique correlation ID, error category, and context.
Input Fields: Input Fields
Output Fields: Output Fields

Read an Owner by Given ID or UserID

ID: get_read_owner_by_id_or_userid
Operation: read
Entities: team, error, owner
Summary: This API endpoint retrieves an owner by a given ID or userId. It requires the 'crm.objects.owners.read' scope for authentication. The request must include the 'authorization' header with a Bearer token. The 'ownerId' path parameter is required to specify the owner to retrieve. Optional query parameters include 'idProperty' to specify the property for ID lookup (default is 'id') and 'archived' to filter archived results (default is false). The response includes details about the owner such as first name, last name, email, and associated teams. In case of an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Render Event Template as HTML

ID: get_render_event_template_as_html
Operation: read
Entities: template, event template, event
Summary: This API endpoint renders either the header or detail of an event template as HTML. It requires the eventTemplateId and eventId as path parameters. Optionally, a query parameter 'detail' can be set to 'true' to render the detailTemplate instead of the headerTemplate. The request must include an 'accept' header set to 'text/html' and an 'authorization' header with a valid Bearer token. The response will be the rendered HTML content. If there are any errors, a detailed error message will be provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get Sample Card Detail Response

ID: get_sample_card_detail_response
Operation: read
Entities: section, action, card detail
Summary: The 'Get Sample Card Detail Response' API endpoint provides an example card detail response. This response is used to display card details to a user. The API does not require authentication and adheres to standard API rate limits. The response includes details such as the total count of card properties, a URL for more items, card labels, top-level actions, and sections with tokens and actions. The response is structured to include settings for IFRAME types, action hooks, and confirmation prompts. The API returns a successful operation with a 200 status code and provides detailed error information in case of validation errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get Specific Event Template for an App

ID: get_specific_event_template_for_an_app
Operation: read
Entities: CRM object, token, event template
Summary: This API endpoint retrieves a specific event template for a given app using the app ID and event template ID as path parameters. The response includes details about the event template such as its creation and update timestamps, name, header and detail templates, and associated tokens. Each token includes information like its name, type, creation and update timestamps, label, and options. The API does not require any specific scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Get Subscription Details

ID: get_subscription_details
Operation: read
Entities: property, association, subscription
Summary: This API endpoint retrieves details of a subscription object identified by the subscriptionId. The subscriptionId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with propertiesWithHistory. Associations can be retrieved using the associations query parameter. The archived query parameter determines if only archived results are returned. The response includes details such as creation and update timestamps, properties, and associations.
Input Fields: Input Fields
Output Fields: Output Fields

Get Task Details by Task ID

ID: get_task_details_by_task_id
Operation: read
Entities: property, association, task
Summary: This API endpoint retrieves details of a task identified by the taskId. The taskId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can also return properties with their history using the propertiesWithHistory query parameter. Additionally, it can retrieve associated object IDs using the associations query parameter. The archived query parameter controls whether only archived results are returned. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Get Tax Object Details

ID: get_tax_object_details
Operation: read
Entities: property, tax, association
Summary: This API endpoint retrieves details of a tax object identified by the taxId. The taxId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter and can include property history with propertiesWithHistory. Associations can be retrieved using the associations query parameter. The archived query parameter determines if only archived results are returned. The response includes details such as creation and update timestamps, properties, and associations.
Input Fields: Input Fields
Output Fields: Output Fields

Get Ticket Details by Ticket ID

ID: get_ticket_details_by_ticket_id
Operation: read
Entities: property, association, ticket
Summary: This API endpoint retrieves details of a ticket identified by the {ticketId}. The {ticketId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows filtering of returned properties using the properties query parameter, and can also return properties with their history using the propertiesWithHistory query parameter. Additionally, it can retrieve associated object IDs using the associations query parameter. The archived query parameter determines if only archived results should be returned, with a default value of false. The response includes details such as associations, creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Translate Legacy List Id to Modern List Id

ID: get_translate_legacy_list_id_to_modern_list_id
Operation: read
Entities: list
Summary: This API translates a legacy list id from the lists v1 API to a modern list id. It requires the 'crm.lists.read' scope and adheres to standard API rate limits. The request must include the 'accept' and 'authorization' headers, and a query parameter 'legacyListId'. The response will include the modern list id corresponding to the provided legacy list id. In case of errors, detailed error information will be provided, including missing scopes and invalid property names.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Configurations on Association Definitions

ID: get_user_configurations_on_association_definitions
Operation: read
Entities: user configuration, association definition, object type
Summary: This API endpoint retrieves user configurations on all association definitions between two specified object types in HubSpot. It requires an authorization header with a Bearer token. The path parameters 'fromObjectType' and 'toObjectType' specify the object types involved in the association. The response includes details such as the maximum number of object IDs enforced by the user, type ID, label, and category of the association. In case of an error, detailed error information is provided, including missing scopes, invalid property names, and links to relevant documentation.
Input Fields: Input Fields
Output Fields: Output Fields

Get Video Conference Application Settings

ID: get_video_conference_application_settings
Operation: read
Entities: setting, error, video conference application
Summary: This API endpoint retrieves the settings for a video conference application specified by the appId. It requires the appId as a path parameter and the HubSpot developer API key as a query parameter. The response includes URLs for verifying users, creating, updating, and deleting meetings. In case of an error, detailed error information is provided, including a correlation ID and links to relevant documentation.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Call Object

ID: patch_partial_update_crm_call_object
Operation: write
Entities: property, call, error
Summary: This API endpoint allows for a partial update of a CRM call object identified by the callId or optionally by a unique property value specified by the idProperty query parameter. The callId refers to the internal object ID by default. The API requires an authorization bearer token and content-type header. The request body should contain the properties to be updated. Read-only and non-existent properties will result in an error. The response includes the updated properties, timestamps, and other metadata. Errors are returned with detailed context and remediation steps.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Object by Fee ID

ID: patch_partial_update_crm_object_by_fee_id
Operation: write
Entities: property, fee
Summary: This API endpoint allows for a partial update of a CRM object identified by the feeId or optionally by a unique property value specified by the idProperty query parameter. The feeId refers to the internal object ID by default, while the idProperty query parameter refers to a property whose values are unique for the object. Provided property values will be overwritten, and read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires authorization via a Bearer token and a content-type of application/json. The response includes the updated properties, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Order Object

ID: patch_partial_update_crm_order_object
Operation: write
Entities: property, order, error
Summary: This API endpoint allows for a partial update of a CRM order object identified by the orderId or optionally by a unique property value specified by the idProperty query parameter. The orderId refers to the internal object ID by default, while the idProperty refers to a property with unique values for the object. The provided property values will overwrite existing ones, and read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The response includes the updated properties, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of a Company Object

ID: patch_partial_update_of_a_company_object
Operation: write
Entities: property, company, error
Summary: This API endpoint allows for a partial update of a company object identified by the companyId or optionally by a unique property value specified by the idProperty query parameter. The companyId refers to the internal object ID by default, while the idProperty refers to a property with unique values for the object. The provided property values will overwrite existing ones, and read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires authorization with a Bearer token and a content-type of application/json. The response includes the updated properties, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of a Contact Object

ID: patch_partial_update_of_a_contact_object
Operation: write
Entities: property, contact, error
Summary: This API performs a partial update of a contact object identified by the contactId. The contactId is the internal object ID of the contact. The API requires an authorization header with a Bearer token and a content-type header set to application/json. The request body must include a properties object containing the properties to be updated. The properties can include date, radio, number, string, checkbox, dropdown, and multiple checkboxes. The response includes the updated properties, creation and update timestamps, and a history of properties. Errors may occur if read-only or non-existent properties are provided, or if required scopes are missing.
Input Fields: Input Fields
Output Fields: Output Fields

Patch Partial Update of a Deal Object

ID: patch_partial_update_of_a_deal_object
Operation: update
Entities: property, deal
Summary: This API endpoint allows you to partially update a deal object in HubSpot CRM. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The path parameter 'dealId' specifies the deal to update. The body of the request includes 'properties' which are the fields to update, such as amount, closedate, dealname, pipeline, dealstage, and description. Upon successful update, the API returns a 200 status code with details of the updated deal, including its ID and updated properties. In case of errors, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of a Quote Object

ID: patch_partial_update_of_a_quote_object
Operation: write
Entities: property, quote
Summary: This API endpoint allows for a partial update of a Quote object identified by {quoteId}. The {quoteId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The provided property values will overwrite existing ones, while read-only and non-existent properties will be ignored. Properties can be cleared by passing an empty string. The request requires authorization via a Bearer token and a content-type of application/json. The response includes the updated properties, timestamps of creation and last update, and a history of property changes.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Communication Object

ID: patch_partial_update_of_communication_object
Operation: write
Entities: property, scope, communication
Summary: This API performs a partial update of a communication object identified by the communicationId or optionally by a unique property value specified by the idProperty query parameter. The communicationId refers to the internal object ID by default, while the idProperty refers to a property with unique values for the object. Provided property values will be overwritten, and read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The response includes the updated properties, creation and update timestamps, and any properties with history.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Lead Object

ID: patch_partial_update_of_crm_lead_object
Operation: write
Entities: lead, error, property
Summary: This API endpoint allows for a partial update of a CRM lead object identified by the 'leadsId' path parameter or optionally by a unique property value specified by the 'idProperty' query parameter. The request requires authorization via a Bearer token and a JSON body containing the properties to update. The properties provided in the request body will overwrite existing values, and read-only or non-existent properties will result in an error. The response includes the updated properties and timestamps for creation and last update. Errors are detailed with specific categories and context.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Note Object

ID: patch_partial_update_of_crm_note_object
Operation: write
Entities: property, error, note
Summary: This API endpoint allows for a partial update of a CRM Note object identified by the noteId. The noteId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API requires the crm.objects.contacts.write scope and adheres to standard API rate limits. The request body should contain the properties to be updated, and any provided property values will overwrite existing ones. Read-only and non-existent properties will be ignored, and properties can be cleared by passing an empty string. The response includes the updated properties and metadata such as creation and update timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Object

ID: patch_partial_update_of_crm_object
Operation: write
Entities: property, scope, object
Summary: This API performs a partial update of a CRM object identified by {objectId} or optionally by a unique property value specified by the idProperty query parameter. The {objectId} refers to the internal object ID by default. The API requires authentication via a Bearer token and supports various scopes for access. The request body must include the properties to be updated, and any provided property values will overwrite existing ones. Read-only and non-existent properties will result in an error. The response includes the updated properties and timestamps for creation and update. Errors are detailed with specific categories and context.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Task Object

ID: patch_partial_update_of_crm_task_object
Operation: write
Entities: property, task, error
Summary: This API endpoint allows for a partial update of a CRM Task Object identified by {taskId}. The {taskId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The provided property values will overwrite existing ones, while read-only and non-existent properties will be ignored. Properties can be cleared by passing an empty string. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The response includes the updated properties, timestamps for creation and last update, and a history of property changes.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of CRM Ticket Object

ID: patch_partial_update_of_crm_ticket_object
Operation: write
Entities: property, ticket, error
Summary: This API endpoint allows for a partial update of a CRM ticket object identified by {ticketId} or optionally by a unique property value specified by the idProperty query parameter. The {ticketId} refers to the internal object ID by default, while the idProperty query parameter refers to a property whose values are unique for the object. The provided property values will overwrite existing values. Read-only and non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The response includes the updated properties, timestamps, and history of changes.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Discount Object

ID: patch_partial_update_of_discount_object
Operation: write
Entities: discount, property
Summary: This API endpoint allows for a partial update of a discount object identified by the discountId or optionally by a unique property value specified by the idProperty query parameter. The discountId refers to the internal object ID by default, while the idProperty refers to a property with unique values for the object. The provided property values will overwrite existing ones, and read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires authorization via a Bearer token and a content-type of application/json. The response includes the updated properties and timestamps of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Email Object

ID: patch_partial_update_of_email_object
Operation: write
Entities: property, email, error
Summary: This API performs a partial update of an email object identified by {emailId} or optionally by a unique property value specified by the idProperty query parameter. The {emailId} refers to the internal object ID by default, and the idProperty query parameter 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. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The response includes the updated properties and timestamps for creation and update.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Line Item Object

ID: patch_partial_update_of_line_item_object
Operation: write
Entities: property, line item, error
Summary: This API endpoint allows for a partial update of a line item object identified by the lineItemId or optionally by a unique property value specified by the idProperty query parameter. The lineItemId refers to the internal object ID by default, while the idProperty query parameter refers to a property whose values are unique for the object. Provided property values will be overwritten, and read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires authorization via a Bearer token and a content-type of application/json. The response includes the updated properties, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Meeting Object

ID: patch_partial_update_of_meeting_object
Operation: write
Entities: property, meeting, error
Summary: This API endpoint allows for a partial update of a meeting object identified by the meetingId. The meetingId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request body should contain the properties to be updated, and any provided property values will overwrite existing ones. Read-only and non-existent properties will be ignored, and properties can be cleared by passing an empty string. The response includes the updated properties, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Product Object

ID: patch_partial_update_of_product_object
Operation: write
Entities: property, error, product
Summary: This API performs a partial update of a product object identified by {productId}. The {productId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API requires an authorization bearer token and content-type header. The request body must include the properties to be updated. Read-only and non-existent properties will result in an error. The response includes the updated properties and timestamps. Errors provide detailed messages and context.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Tax Object

ID: patch_partial_update_of_tax_object
Operation: write
Entities: property, tax, scope
Summary: This API performs a partial update of a Tax object identified by {taxId}. The {taxId} can be the internal object ID or any unique property value specified by the idProperty query parameter. The API allows updating specific properties of the object, where provided property values will overwrite existing ones. Read-only and non-existent properties will be ignored, and properties can be cleared by passing an empty string. The request requires authorization via a Bearer token and the content type must be set to application/json. The response includes the updated properties, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Partial Update of Postal Mail Object

ID: patch_partial_update_postal_mail_object
Operation: write
Entities: property, postal mail, error
Summary: This API endpoint allows for a partial update of a postal mail object identified by the postalMailId. The postalMailId can be the internal object ID or any unique property value specified by the idProperty query parameter. The API requires authorization via a Bearer token and accepts a JSON body containing the properties to be updated. Read-only and non-existent properties will be ignored, and properties can be cleared by passing an empty string. The response includes the updated properties and timestamps of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Pipeline

ID: patch_update_a_pipeline
Operation: write
Entities: metadata, stage, pipeline
Summary: This API endpoint allows for a partial update of a pipeline identified by the pipelineId. It requires authentication via a Bearer token and supports both private apps and OAuth. The request can include path parameters for objectType and pipelineId, optional query parameters for validation checks, and a body to update properties such as archived status, display order, and label. The response includes details of the updated pipeline, including creation and update timestamps, archived status, display order, stages, and labels. Errors are returned with detailed context and remediation steps.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Property in HubSpot

ID: patch_update_a_property_in_hubspot
Operation: write
Entities: property, option, modification metadata
Summary: This API endpoint allows for the partial update of a property in HubSpot identified by the propertyName. The provided fields in the request body will overwrite the existing property fields. The API requires authentication via a Bearer token and supports both private apps and OAuth. The request includes path parameters for objectType and propertyName, and a JSON body with optional fields such as groupName, hidden, options, displayOrder, description, calculationFormula, label, type, fieldType, and formField. The response includes details about the updated property, such as createdUserId, hidden status, modification metadata, display order, description, label, type, and more. The API adheres to standard API rate limits and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Update Calling App's Recording Settings

ID: patch_update_calling_app_recording_settings
Operation: write
Entities: error, app, recording setting
Summary: This API updates the URL that HubSpot will use to retrieve call recordings for a calling extension app. It requires the app ID as a path parameter and the URL to retrieve the authenticated recording as a body parameter. The request must include the HubSpot developer API key as a query parameter. The response will return the updated URL if successful, or an error message with details if there is a validation error.
Input Fields: Input Fields
Output Fields: Output Fields

Update Calling Extension Settings

ID: patch_update_calling_extension_settings
Operation: write
Entities: setting, service, calling extension
Summary: This API updates existing calling extension settings for a specified app in HubSpot. It requires the app ID as a path parameter and the developer API key as a query parameter. The request body can include parameters such as supportsCustomObjects, isReady, name, width, supportsInboundCalling, url, and height to configure the calling service. The response includes details about the calling extension settings, such as creation and update timestamps, and the configured parameters.
Input Fields: Input Fields
Output Fields: Output Fields

Update Cart Object Partially

ID: patch_update_cart_object_partially
Operation: write
Entities: cart
Summary: This API endpoint allows for a partial update of a cart object identified by {cartId} or optionally by a unique property value specified by the idProperty query parameter. The {cartId} refers to the internal object ID by default, while the idProperty query parameter refers to a property whose values are unique for the object. Provided property values will be overwritten, and read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. The request requires authentication with a Bearer token and the 'crm.objects.carts.write' scope. The response includes the updated properties of the cart, timestamps for creation and last update, and a history of property changes.
Input Fields: Input Fields
Output Fields: Output Fields

Update CRM Card Definition

ID: patch_update_crm_card_definition
Operation: write
Entities: property, app, card
Summary: This API endpoint allows you to update a CRM card definition with new details. It requires the app ID and card ID as path parameters, and the HubSpot developer API key as a query parameter. The request body can include optional fields such as fetch configuration, display properties, title, and actions. The response includes the updated card details, including creation and update timestamps, title, fetch configuration, display properties, and actions.
Input Fields: Input Fields
Output Fields: Output Fields

Update Object Schema

ID: patch_update_object_schema
Operation: write
Entities: property, object, schema
Summary: The Update Object Schema API allows you to update the details of an existing object schema in HubSpot. You can modify attributes such as secondary display properties, required properties, searchable properties, and labels. The request requires a path parameter 'objectType' which is the fully qualified name or object type ID of your schema. The request body can include various properties to update, such as 'secondaryDisplayProperties', 'requiredProperties', 'searchableProperties', 'primaryDisplayProperty', 'description', 'restorable', and 'labels'. The response includes details of the updated schema, such as 'objectTypeId', 'description', 'fullyQualifiedName', 'labels', 'archived', 'createdAt', 'portalId', 'primaryDisplayProperty', 'name', 'id', and 'updatedAt'.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Pipeline Stage

ID: patch_update_pipeline_stage
Operation: write
Entities: metadata, stage, pipeline
Summary: This API endpoint allows for a partial update of a pipeline stage identified by {stageId} associated with a pipeline identified by {pipelineId}. The request requires authorization via a Bearer token and accepts parameters in the path for objectType, pipelineId, and stageId. The body of the request can include fields such as 'archived', 'metadata', 'displayOrder', and 'label'. The response returns the updated pipeline stage details including creation and update timestamps, archived status, metadata, display order, permissions, label, and unique ID. Errors are detailed with specific categories and context.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Property Group

ID: patch_update_property_group
Operation: write
Entities: property group, group name, object type
Summary: This API endpoint allows for the partial update of a property group identified by {groupName} within a specified {objectType}. The provided fields in the request body will overwrite existing values. The request requires authorization via a Bearer token and supports updating the display order and label of the property group. The response includes the updated property group details, such as whether it is archived, its internal name, display order, and label. The API requires specific scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Add Token to Event Template

ID: post_add_token_to_event_template
Operation: write
Entities: CRM object, token, event template
Summary: This API endpoint allows you to add a token to an existing event template in HubSpot. The token can be used to attach custom data to events displayed in a timeline or used for list segmentation. The request requires the app ID and event template ID as path parameters, and the HubSpot developer API key as a query parameter. The request body must include the token's name, label, and type, and may include options if the type is enumeration. The response returns the details of the created token, including its name, type, creation and update timestamps, label, and options if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of CRM Objects by ID

ID: post_archive_batch_crm_objects
Operation: write
Entities: scope, error, object
Summary: This API endpoint allows you to archive a batch of CRM objects by their IDs. You need to specify the object type in the path parameter and provide an array of object IDs in the request body. The request requires authentication via a Bearer token. On success, it returns a 204 No Content response. In case of errors, it provides detailed error information including subcategories, context, correlation ID, and human-readable messages.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Discounts by ID

ID: post_archive_batch_discounts
Operation: write
Entities: discount, line item, error
Summary: This API archives a batch of discounts by their IDs. It requires an authorization header with a Bearer token and a content-type header set to application/json. The request body must contain an array of discount objects, each with an 'id' field specifying the discount to be archived. The API returns a 204 No Content response on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Line Items by ID

ID: post_archive_batch_line_items
Operation: write
Entities: line item, error, scope
Summary: This API archives a batch of line items by their IDs. It requires an array of line item IDs in the request body. The request must include an authorization header with a Bearer token and a content-type header set to application/json. On success, it returns a 204 No Content response. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Calls by ID

ID: post_archive_batch_of_calls
Operation: write
Entities: call, error, context
Summary: This API endpoint archives a batch of calls by their IDs. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of call objects, each with an 'id' field specifying the call to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Carts by ID

ID: post_archive_batch_of_carts
Operation: write
Entities: cart, error
Summary: This API endpoint archives a batch of carts by their IDs. It requires the 'crm.objects.carts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of cart objects, each with an 'id' field specifying the cart to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Communications by ID

ID: post_archive_batch_of_communications
Operation: write
Entities: communication
Summary: This API endpoint allows you to archive a batch of communications by their IDs. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of communication objects, each with an 'id' field. A successful request returns a 204 No Content response. In case of errors, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Companies by ID

ID: post_archive_batch_of_companies
Operation: write
Entities: company, error
Summary: This API endpoint allows you to archive a batch of companies by their IDs. It requires the 'crm.objects.companies.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of company IDs to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Contacts by ID

ID: post_archive_batch_of_contacts
Operation: write
Entities: contact, error, parameter
Summary: This API endpoint allows you to archive a batch of contacts by their IDs. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of contact IDs under the 'inputs' key. A successful request returns a 204 No Content response. In case of an error, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Deals by ID

ID: post_archive_batch_of_deals
Operation: write
Entities: deal, error
Summary: This API endpoint allows you to archive a batch of deals by their IDs. It requires the 'crm.objects.deals.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of deal objects, each with an 'id' field specifying the deal to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Emails by ID

ID: post_archive_batch_of_emails_by_id
Operation: write
Entities: email, error, context
Summary: This API endpoint allows you to archive a batch of emails by their IDs. It requires an authorization bearer token and the content type to be set as 'application/json'. The request body must contain an array of email objects, each with an 'id' field specifying the email to be archived. On success, the API returns a 204 No Content response. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Fees by ID

ID: post_archive_batch_of_fees
Operation: write
Entities: scope, fee, error
Summary: This API archives a batch of fees by their IDs. It requires an authorization header with a Bearer token and a content-type header set to application/json. The request body must contain an array of fee objects, each with an 'id' field specifying the fee to be archived. The API responds with HTTP 204 No Content on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Leads by ID

ID: post_archive_batch_of_leads
Operation: write
Entities: lead, error, context
Summary: This API endpoint allows you to archive a batch of leads by their IDs. It requires the 'crm.objects.leads.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of lead objects, each with an 'id' field specifying the lead to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Meetings by ID

ID: post_archive_batch_of_meetings
Operation: write
Entities: meeting, error, request
Summary: This API endpoint allows you to archive a batch of meetings by their IDs. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of meeting objects, each with an 'id' field specifying the meeting to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Notes by ID

ID: post_archive_batch_of_notes
Operation: write
Entities: error, note
Summary: This API endpoint allows you to archive a batch of notes by their IDs. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of note IDs under the 'inputs' key. A successful request returns an HTTP 204 status with no content. In case of errors, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Orders by ID

ID: post_archive_batch_of_orders
Operation: write
Entities: order, error, context
Summary: This API endpoint archives a batch of orders by their IDs. It requires the 'crm.objects.orders.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of order IDs to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Products by ID

ID: post_archive_batch_of_products
Operation: write
Entities: error, product
Summary: This API endpoint archives a batch of products by their IDs. It requires an authorization bearer token and a content-type header set to application/json. The request body must contain an array of product IDs under the 'inputs' key. A successful request returns a 204 No Content status. In case of errors, the response includes details such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Properties

ID: post_archive_batch_of_properties
Operation: write
Entities: property, parameter, scope
Summary: This API endpoint archives a batch of properties for a specified object type. It requires the 'objectType' path parameter to specify the type of object whose properties are to be archived. The request body must include an array of 'inputs', each containing the 'name' of the property to be archived. The request headers must include an authorization bearer token and specify the content type as 'application/json'. On success, the API returns a 204 No Content response. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Quotes by ID

ID: post_archive_batch_of_quotes
Operation: write
Entities: quote
Summary: This API endpoint allows you to archive a batch of quotes by their IDs. It requires an authorization bearer token and the content type must be set to application/json. The request body must include an array of quote IDs under the 'inputs' key. The API returns a 204 No Content response on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and errors array with specific details about each error.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Tasks by ID

ID: post_archive_batch_of_tasks
Operation: write
Entities: task, error
Summary: This API endpoint allows you to archive a batch of tasks by their IDs. It requires authorization via a Bearer token and expects a JSON body containing an array of task objects, each with an 'id' field. The API responds with HTTP 204 No Content on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Taxes by ID

ID: post_archive_batch_of_taxes
Operation: write
Entities: id, tax, error
Summary: This API endpoint allows you to archive a batch of taxes by their IDs. It requires the 'crm.objects.line_items.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of tax objects, each with an 'id' field specifying the tax to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and a list of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Tickets by ID

ID: post_archive_batch_of_tickets
Operation: write
Entities: ticket, error, context
Summary: This API endpoint archives a batch of tickets by their IDs. It requires an authorization header with a Bearer token and a content-type header set to application/json. The request body must contain an array of ticket IDs under the 'inputs' key. The API returns a 204 No Content response on success. In case of errors, it provides detailed error information including subCategory, context, correlationId, links, message, category, and errors array with specific error details.
Input Fields: Input Fields
Output Fields: Output Fields

Archive a Batch of Postal Mail by ID

ID: post_archive_batch_postal_mail
Operation: write
Entities: postal mail, error, request
Summary: This API endpoint archives a batch of postal mail by their IDs. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of postal mail objects, each with an 'id' field specifying the ID of the postal mail to be archived. A successful request returns a 204 No Content response. In case of errors, the response includes detailed error information such as subCategory, context, correlationId, links, message, category, and an array of errors with specific details.
Input Fields: Input Fields
Output Fields: Output Fields

Batch Create User Configurations Between Two Object Types

ID: post_batch_create_user_configurations
Operation: write
Entities: user, configuration, object type
Summary: This API endpoint allows for batch creation of user configurations between two specified object types in HubSpot. The request requires authorization via a Bearer token and must include the object types in the path parameters. The body of the request should contain an array of configuration objects, each specifying a typeId, category, and maxToObjectIds. The response will indicate the status of the operation, with possible outcomes including successful creation (HTTP 201), multiple statuses (HTTP 207), or an error response detailing validation issues. The API requires specific scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Batch Delete User Configurations Between Two Object Types

ID: post_batch_delete_user_configurations
Operation: write
Entities: user configuration, association definition, object type
Summary: This API endpoint allows for the batch deletion of user configurations between two specified object types in the CRM. The request requires authorization via a Bearer token and specifies the object types in the path parameters. The body of the request contains an array of configurations to be deleted, each with a typeId and category. The response provides detailed error information if the request fails, including a correlationId for tracking and a message with remediation steps.
Input Fields: Input Fields
Output Fields: Output Fields

Batch Read Associations for CRM Objects

ID: post_batch_read_associations_for_crm_objects
Operation: read
Entities: association, error, object
Summary: This API endpoint allows batch reading of associations between CRM objects of specified types. It requires authentication via a Bearer token and supports various scopes for access control. The request includes path parameters for the object types and a body containing an array of input objects with 'id' and optional 'after' fields for pagination. The response provides timestamps for the request, start, and completion of the operation, along with results detailing the associations and paging information. The 'paging' field is included only if there are additional pages to retrieve.
Input Fields: Input Fields
Output Fields: Output Fields

Batch Update User Configurations Between Two Object Types

ID: post_batch_update_user_configurations
Operation: write
Entities: user, configuration, object type
Summary: This API endpoint allows for batch updating of user configurations between two specified object types. It requires authorization with a Bearer token and accepts a JSON body containing an array of configuration inputs. Each input must specify a typeId, category, and maxToObjectIds. The response can either be a successful operation with a status of 'PENDING' or a multi-status response indicating errors. The response includes timestamps for when the operation was requested, started, and completed, as well as any relevant links and results or errors.
Input Fields: Input Fields
Output Fields: Output Fields

Cancel an Active Import

ID: post_cancel_active_import
Operation: write
Entities: link, import, error
Summary: This API allows a developer to cancel an active import in HubSpot. The request requires an authorization header with a Bearer token and a path parameter 'importId' which specifies the ID of the import to be canceled. Upon successful cancellation, the API returns a response with timestamps for when the import was completed, requested, and started, along with related links and the current status of the import. If there is an error, a detailed error message is provided with context and links to documentation for remediation.
Input Fields: Input Fields
Output Fields: Output Fields

Configure a Calling Extension

ID: post_configure_calling_extension
Operation: write
Entities: setting, error, calling extension
Summary: This API is used to configure a calling extension by setting the menu label, target iframe URL, and dimensions for your calling extension. It requires the app ID as a path parameter and the developer API key as a query parameter. The request body includes parameters such as supportsCustomObjects, isReady, name, width, supportsInboundCalling, url, and height. The response includes details about the calling extension such as when it was created, its compatibility with custom objects, readiness status, name, iframe dimensions, and the last update time.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Deals

ID: post_create_a_batch_of_deals
Operation: write
Entities: property, association, deal
Summary: This API endpoint allows you to create a batch of deals in HubSpot. It requires authentication via a Bearer token and accepts a JSON body containing an array of deal objects. Each deal object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each created deal, including its properties and history. The API supports OAuth and requires the 'crm.objects.deals.write' scope. Standard API rate limits apply.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Fees

ID: post_create_a_batch_of_fees
Operation: write
Entities: property, association, fee
Summary: This API endpoint allows you to create a batch of fees in the CRM system. It requires authorization via a Bearer token and accepts a JSON body containing an array of fee objects. Each fee object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each fee created, including its properties and history. The API supports standard and granular scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Cart

ID: post_create_a_cart
Operation: write
Entities: cart, association, property
Summary: This API endpoint allows you to create a cart with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes an array of associations and a properties object containing the cart's name, currency code, and external ID. Upon successful creation, the API returns a 201 status code along with the cart's details, including its ID, creation timestamp, and properties. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Communication

ID: post_create_a_communication
Operation: write
Entities: property, association, communication
Summary: This API endpoint allows you to create a communication object in HubSpot with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes an array of associations, each containing types and a target object ID, and a properties object with additional properties. Upon successful creation, the API returns a 201 status code along with the created communication object, including its ID, creation and update timestamps, and properties with history. If there is an error, a detailed error message with context and remediation steps is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Company

ID: post_create_a_company
Operation: write
Entities: property, association, company
Summary: This API endpoint allows you to create a company with specified properties and associations in HubSpot. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes 'associations' and 'properties'. Associations are defined as an array of objects, each containing 'types' and 'to' fields. Properties are defined as an object with additional properties. Upon successful creation, the API returns a 201 status code with details of the created company, including its ID, creation timestamp, and properties with history. In case of errors, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Deal in HubSpot CRM

ID: post_create_a_deal_in_hubspot_crm
Operation: write
Entities: property, association, deal
Summary: This API endpoint allows you to create a deal in HubSpot CRM with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes 'associations' and 'properties'. Associations are defined as an array of objects, each containing types and a target object ID. Properties are defined as an object with additional properties. Upon successful creation, the API returns a 201 status code with details of the created deal, including its ID, creation timestamp, and properties with history. In case of errors, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Discount

ID: post_create_a_discount
Operation: write
Entities: discount, association, property
Summary: This API endpoint allows you to create a discount with specified properties and associations. The request requires authentication via a Bearer token and must include the properties and associations in the request body. The response returns the created discount object, including its ID, creation timestamp, and properties with history. The API supports standard and granular scopes for e-commerce and CRM objects line items write operations. Standard API rate limits apply.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Lead

ID: post_create_a_lead
Operation: write
Entities: lead, association, property
Summary: This API endpoint allows you to create a lead with specified properties and associations in HubSpot. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes an array of associations and a properties object. The response returns a copy of the created lead object, including its ID, creation and update timestamps, and properties with history. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Meeting

ID: post_create_a_meeting
Operation: write
Entities: property, association, meeting
Summary: This API endpoint allows you to create a meeting with specified properties and associations. The request requires authorization via a Bearer token and must include a JSON body with 'associations' and 'properties'. The 'associations' parameter is an array of objects that define the types and associated object IDs. The 'properties' parameter is an object containing additional properties of the meeting. Upon successful creation, the API returns a 201 status code along with the meeting details, including its ID, creation timestamp, and properties with history. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Pipeline

ID: post_create_a_pipeline
Operation: write
Entities: metadata, pipeline stage, pipeline
Summary: This API endpoint allows you to create a new pipeline in HubSpot with specified property values. The request requires an authorization token and a content-type header. The objectType path parameter specifies the type of object for which the pipeline is being created. The request body must include a displayOrder, an array of stages with each stage having a label, metadata, and displayOrder, and a unique label for the pipeline. The response returns the entire pipeline object, including its unique ID, creation date, and stage details. The API requires specific scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Updated 7 days ago