# HubSpot docs: APIs 2026-09 CRM ## CRM - [HubSpot CRM embed](https://developers.hubspot.com/docs/api-reference/latest/crm/embed.md): Learn how to embed a HubSpot view such as a record timeline, property history, or meeting link in a third-party platform. - [CRM Search API](https://developers.hubspot.com/docs/api-reference/latest/crm/search-the-crm.md): The CRM search endpoints make getting data more efficient by allowing developers to filter, sort, and search across any CRM object type. - [Understanding the CRM APIs](https://developers.hubspot.com/docs/api-reference/latest/crm/understanding-the-crm.md): HubSpot's CRM is a system for managing customer relationships and data. Learn about objects and the related CRM APIs. - [Using Object APIs](https://developers.hubspot.com/docs/api-reference/latest/crm/using-object-apis.md): Learn how to use the object API endpoints to create and manage records or activities. - [APIs / 2026-09 / CRM / Objects (398 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects.txt): Documentation for APIs / 2026-09 / CRM / Objects. ### Activities #### Calls - [Calls API](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/guide.md): Use the calls engagement API to log and manage calls on CRM records. - [Create a call](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/create-call.md): Create a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided. - [Retrieve a call](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/get-call.md): Read an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve calls](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/get-calls.md): Read a page of calls. Control what is returned via the `properties` query param. - [Update a call](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/update-call.md): Perform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Prov… - [Archive a call](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/delete-call.md): Move an Object identified by `{callId}` to the recycling bin. ##### Batch - [Create calls](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/batch/create-calls.md): Create a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. - [Retrieve calls](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/batch/get-calls.md): Retrieve a batch of calls by ID. - [Update calls](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/batch/update-calls.md): Update a batch of calls by ID. - [Upsert calls](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/batch/upsert-calls.md): Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. - [Archive calls](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/batch/delete-calls.md): Archive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record). ##### Search - [Search for calls](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/calls/search/search-calls.md): Search for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). #### Emails - [Emails API](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/guide.md): Use the email engagement API to log and manage emails on CRM records. - [Create an email](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/create-email.md): Create a CRM object with the specified properties and return a copy of the object, including its ID. This endpoint is useful for adding new objects to your CRM system with predefined attributes. Documentation and examples for creating standard objects are provided to assist with the process. - [Retrieve an email](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/get-email.md): Read an object identified by `{objectId}`. By default, `{objectId}` refers to the internal object ID, but it can also be any unique property value specified by the `idProperty` query parameter. You can control the data returned by specifying the `properties` query parameter. - [Retrieve emails](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/get-emails.md): Read a page of objects of a specified type in your HubSpot account. You can control the data returned by specifying properties, associations, and whether to include archived records. This endpoint is useful for retrieving a list of CRM objects with specific details and associations. - [Update an email](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/update-email.md): Perform a partial update of an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will b… - [Delete an email](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/delete-email.md): Move an Object identified by `{objectId}` to the recycling bin. This operation allows you to archive a specific CRM object by its unique ID, effectively removing it from active use but retaining it in the system for potential recovery or reference. ##### Batch - [Create emails](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/batch/create-emails.md): Create a batch of CRM objects with specified properties. This endpoint allows you to efficiently create multiple objects in a single request, which can be useful for bulk data imports or synchronizing data from other systems. The response includes a copy of each created object, including their IDs. - [Retrieve emails](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/batch/get-emails.md): Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint is useful for fetching multiple objects in a single request, allowing for efficient data retrieval. It supports filtering for archived objects if needed. - [Update emails](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/batch/update-emails.md): Update a batch of CRM objects in HubSpot using their unique identifiers. This endpoint allows you to modify multiple objects in a single request, making it efficient for bulk updates. Ensure that the request body contains the necessary properties for each object you wish to update. - [Upsert emails](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/batch/upsert-emails.md): Create or update a batch of CRM objects in HubSpot using unique property values. This endpoint allows for efficient management of multiple objects by either creating new entries or updating existing ones based on the provided unique identifiers. - [Delete emails](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/batch/delete-emails.md): Archive a batch of CRM objects by their IDs. This endpoint is useful for managing large sets of objects that need to be archived simultaneously, streamlining the process of moving multiple objects to the archive. ##### Search - [Search for emails](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/emails/search/search-emails.md): Search for CRM objects of a specified type using various filters and criteria. This endpoint allows you to perform complex searches by specifying filter groups, sorting options, and properties to be included in the response. It is useful for retrieving specific objects based on detailed search param… #### Meetings - [Meetings API](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/guide.md): Use the meetings engagement API to log and manage meetings on CRM records. - [Create meeting](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/create-meeting.md): Create a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided. - [Retrieve meeting](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/get-meeting.md): Read an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve meetings](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/get-meetings.md): Read a page of meetings. Control what is returned via the `properties` query param. - [Update meeting](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/update-meeting.md): Perform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object… - [Delete meeting](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/delete-meeting.md): Move an Object identified by `{meetingId}` to the recycling bin. ##### Batch - [Create meetings](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/batch/create-meetings.md): Create a batch of meetings. The `inputs` array can contain a `properties` object to define property values for the record, along with an `associations` array to define relationships with other object records. - [Retrieve meetings](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/batch/get-meetings.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update meetings](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/batch/update-meetings.md): Update a batch of meetings by ID (`objectId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string. - [Upsert meetings](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/batch/upsert-meetings.md): Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. - [Delete meetings](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/batch/delete-meetings.md): Delete a batch of meetings by ID. ##### Search - [Search for meetings](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/meetings/search/search-meetings.md): Search for meetings by filtering on properties, searching through associations, and sorting results. #### Notes - [Notes API](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/guide.md): Use the notes engagement API to log and manage notes on CRM records. - [Create note](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/create-note.md): Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided. - [Retrieve note](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/get-note.md): Read an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve a note](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/get-notes.md): Read a page of notes. Control what is returned via the `properties` query param. - [Update note](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/update-note.md): Perform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Prov… - [Delete a note](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/delete-note.md): Move an Object identified by `{noteId}` to the recycling bin. ##### Batch - [Create notes](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/batch/create-notes.md): Create multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers. - [Retrieve notes](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/batch/get-notes.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update notes](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/batch/update-notes.md): Update multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk. - [Upsert notes](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/batch/upsert-notes.md): Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. - [Delete notes](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/batch/delete-notes.md): Archive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries. ##### Search - [Search for notes](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/notes/search/search-notes.md): Execute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system. #### Postal mail - [Postal Mail API](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/guide.md): Use the postal mail engagement API to log any postal mail you've sent to or received from contacts or companies on their CRM records. - [Create postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/create-postal-mail.md): Create a CRM object with the specified properties and return a copy of the object, including its ID. This endpoint is useful for adding new records to your CRM system with all necessary details. Documentation and examples for creating standard objects are provided. - [Get postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/get-postal-mail-objectId.md): Read an object identified by `{objectId}` in the specified `{objectType}`. By default, `{objectId}` refers to the internal object ID, but you can specify a unique property using the `idProperty` query parameter. You can control the data returned by using the `properties` query parameter to specify w… - [Get all postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/get-postal-mail.md): Read a page of objects of a specified type in your HubSpot account. You can control the data returned by specifying which properties to include via the `properties` query parameter. This endpoint is useful for retrieving a list of objects with specific attributes for further processing or analysis. - [Update postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/update-postal-mail-objectId.md): Perform a partial update of an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will b… - [Update postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/update-postal-mail.md): Perform a partial update of an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will b… - [Archive postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/delete-postal-mail.md): Move an Object identified by `{objectId}` to the recycling bin. This operation allows you to archive a specific CRM object by its ID, effectively removing it from active use while retaining it for potential future restoration. ##### Batch - [Create postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/batch/create-postal-mail.md): Create a batch of CRM objects of a specified type in HubSpot. This endpoint allows you to create multiple objects in a single request, which can be useful for efficiently importing data or synchronizing with external systems. The request body must include the properties for each object to be created… - [Retrieve postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/batch/get-postal-mail.md): Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint is useful for fetching multiple objects in a single request, allowing for efficient data retrieval. You can specify whether to include archived objects in the response. - [Update postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/batch/update-postal-mail-objectType.md): Update a batch of CRM objects in your HubSpot account. This endpoint allows you to modify multiple objects at once by providing their properties. It is useful for bulk updates, ensuring consistency and efficiency in managing CRM data. - [Set default association](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/batch/update-postal-mail.md): Create the default association type between two specified object types in the CRM. This endpoint is useful for establishing a generic relationship between different CRM objects, such as contacts and companies, or deals and tickets. - [Upsert postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/batch/upsert-postal-mail.md): Create or update a batch of CRM objects by unique property values. This endpoint allows you to efficiently manage multiple objects in a single request, ensuring that each object is either created or updated based on the provided unique identifiers. - [Archive postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/batch/delete-postal-mail.md): Archive a batch of CRM objects by their IDs. This endpoint is useful for moving multiple objects to the recycling bin in a single request, which can help streamline data management and cleanup processes. ##### Search - [Search for postal mail](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/postal-mail/search/search-postal-mail.md): Search for CRM objects of a specified type using various filters and criteria. This endpoint allows you to perform complex queries to retrieve objects that match your specified conditions. It is useful for finding specific objects based on their properties or associations. #### Task series - [Task series API](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/task-series/guide.md): Create and manage regularly recurring tasks using the task series API. - [Create a recurring task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/task-series/create-tasks-series.md): Create a new task series in the HubSpot CRM. This endpoint allows you to start a series of tasks by providing the necessary properties and series details. It is useful for automating repetitive task sequences within your CRM workflows. - [Retrieve recurring task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/task-series/get-tasks-series.md): Retrieve details of a specific task series using its unique identifier. This endpoint allows you to access the properties and series information associated with the specified taskId. It's useful for obtaining detailed information about a task series, including any custom properties. - [Update recurring task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/task-series/update-tasks-series.md): Update the details of a specific task series in your HubSpot account. This endpoint allows you to modify properties and series configurations for the task identified by the taskId. Use this to adjust task scheduling or update task-related information. - [Stop recurring task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/task-series/delete-tasks-series.md): Delete a specific task series in your HubSpot account using its unique identifier. This operation permanently removes the task series, and it cannot be undone. Ensure that you have the necessary permissions to perform this action. #### Tasks - [Tasks API](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/guide.md): Use the tasks engagement API to log and manage tasks on CRM records. - [Create a task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/create-task.md): Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided. - [Retrieve a task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/get-task.md): Read an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve tasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/get-tasks.md): Read a page of tasks. Control what is returned via the `properties` query param. - [Subtasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/subtasks-guide.md): Use the tasks API to create subtasks. - [Update a task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/update-task.md): Perform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Prov… - [Delete a task](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/delete-task.md): Move an Object identified by `{taskId}` to the recycling bin. ##### Batch - [Create tasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/batch/create-tasks.md): Create multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together. - [Retrieve tasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/batch/get-tasks.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update tasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/batch/update-tasks.md): Update multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data. - [Upsert tasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/batch/upsert-tasks.md): Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object. - [Delete tasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/batch/delete-tasks.md): Archive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body. ##### Search - [Search for tasks](https://developers.hubspot.com/docs/api-reference/latest/crm/activities/tasks/search/search-tasks.md): Execute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values. ### Associations - [Associations overview](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/overview.md): Learn how to create and manage associations between object records via the API. #### Associate records - [Associate records](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/guide.md): Use the associations API to create, manage, and remove associations between CRM records. - [Report high usage](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/report-high-usage.md): Requests a report of all objects in the portal which have a high usage of associations - [Associate records (labeled)](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/update-association-labeled.md): Set association labels between two records. - [Associate records (default)](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/update-association.md): Create the default (most generic) association type between two object types - [Remove association between records](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/delete-association.md): deletes all associations between two records. ##### Batch - [Associate records (labeled)](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/batch/create-associations-labeled.md): Batch create associations for objects - [Associate records (default)](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/batch/create-associations.md): Create the default (most generic) association type between two object types - [Retrieve associations](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/batch/get-associations.md): Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be presen… - [Delete specific labels](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/batch/delete-association-labels.md): Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects - [Remove associations](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associate-records/batch/delete-associations.md): Batch delete associations for objects #### Associations schema - [Configure associations](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/guide.md): The Associations Schema endpoints are used to manage association types across objects. ##### Labels - [Batch create labels](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/labels/create-associations-label-batch.md): Batch configure association limits between two object types. - [Create association label](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/labels/create-associations-label.md): Create a new label that describes the relationship between two specified CRM object types. This can help in categorizing and managing associations more effectively. - [Retrieve association labels](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/labels/get-associations-label.md): Retrieve all labels that describe the relationships between two specified CRM object types. These labels provide context about the nature of the associations. - [Update association label](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/labels/update-associations-label.md): Update an existing label that describes the relationship between two specified CRM object types. This allows for modifications to existing association labels to better reflect the nature of the relationship. - [Delete association label](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/labels/delete-associations-label.md): Remove a specific label from the association between two CRM object types. ##### Limits - [Configure association limits](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/limits/create-associations-limits.md): Batch configure association limits between two object types. - [Retrieve association limits](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/limits/get-all-associations-limits.md): Retrieve the configuration details for associations between two specified CRM object types. Use this endpoint to understand limits that have been set for specific association types. - [Retrieve all association limits](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/limits/get-associations-limits.md): Retrieve all configured association limits between objects, which include details about how different CRM object types are associated with each other. - [Update association limits](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/limits/update-associations-limits.md): Batch update association limits that have been configured between two object types. - [Remove association limits](https://developers.hubspot.com/docs/api-reference/latest/crm/associations/associations-schema/limits/delete-associations-limits.md): Batch delete limits that have been defined for association types between two object types. ### CRM Data Model - [Object Activation API](https://developers.hubspot.com/docs/api-reference/latest/crm/crm-data-model/guide.md): Learn how to check if objects are activated for use in a HubSpot account. - [Is object type is enabled](https://developers.hubspot.com/docs/api-reference/latest/crm/crm-data-model/get-object-library-objectTypeId.md): Fetch whether object type is enabled - [Fetch object type enablement status](https://developers.hubspot.com/docs/api-reference/latest/crm/crm-data-model/get-object-library.md): For all object types supporting enablement, returns whether they're enabled or disabled ### Exports - [Exports API](https://developers.hubspot.com/docs/api-reference/latest/crm/exports/guide.md): Learn how to use the Exports API to export records in views or lists from your HubSpot account. - [Start an export](https://developers.hubspot.com/docs/api-reference/latest/crm/exports/create-export.md): Begins exporting CRM data for the portal as specified in the request body - [Retrieve export status](https://developers.hubspot.com/docs/api-reference/latest/crm/exports/get-export-status.md): Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE - [Retrieve export details](https://developers.hubspot.com/docs/api-reference/latest/crm/exports/get-export.md): Retrieve detailed information about a specific CRM export, including its current state and properties. ### Extensions #### Calling extensions - [Calling extensions SDK](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/calling-sdk.md): Overview of the calling extensions SDK - [CRM API | Receive calls in HubSpot when using calling apps](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/receive-incoming-calls.md): You can receive calls in HubSpot when using calling apps. - [Call recordings and transcripts](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/recordings-and-transcriptions.md): Learn how to log call recordings and their associated transcripts in HubSpot. - [Set up third-party calling in help desk](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/third-party-calling.md): Learn how to set up third-party calling in your HubSpot help desk. - [Third-party transcripts](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/third-party-transcripts.md): Enable HubSpot to use transcripts from a third-party platform as a part of its Conversation Intelligence feature. ##### Channel Connection Settings - [Create new channel connection settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/channel-connection-settings/create-channel-connection-settings.md): Establish new channel connection settings for the specified app. - [Retrieve the channel connection settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/channel-connection-settings/get-channel-connection-settings.md): Access the current channel connection settings for the specified app. - [Update the channel connection settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/channel-connection-settings/update-channel-connection-settings.md): Modify the existing channel connection settings for the specified app. - [Remove the channel connection settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/channel-connection-settings/delete-channel-connection-settings.md): Delete the channel connection settings associated with the specified app. ##### Inbound - [Submit details of an inbound call to the CRM.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/inbound/create-inbound-call.md): This endpoint allows you to submit information about an inbound call to the CRM system. The request must include details such as the external call ID, call status, and involved phone numbers. This operation helps in logging and managing inbound call data within the CRM. ##### Recording - [Mark a call recording as ready for retrieval.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/recording/call-recording-ready.md): This endpoint is used to mark a call recording as ready. It requires the engagementId to identify the specific recording. ##### Settings - [Create new calling extension settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/settings/create-calling-extension.md): Create new settings for the calling extension associated with the specified appId. - [Retrieve the calling extension settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/settings/get-calling-extensions.md): Retrieve the current settings of the calling extension for the specified appId. - [Update the calling extension settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/settings/update-calling-extension.md): Modify existing calling extension settings for the specified appId. Only the fields provided in the request will be updated. - [Delete the calling extension settings for a specific app.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/calling-extensions/settings/delete-calling-extension.md): Remove the calling extension settings associated with the specified appId. This action cannot be undone. #### CRM cards - [Legacy CRM cards](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/guide.md): Learn about CRM cards built for legacy public apps. - [Create a new card](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/create-crm-card.md): Defines a new card that will become active on an account when this app is installed. - [Get a card.](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/get-crm-card.md): Returns the definition for a card with the given ID. - [Get all cards](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/get-crm-cards.md): Returns a list of cards for a given app. - [Get sample card detail response](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/get-sample-response.md): Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request. - [Migrate CRM card views](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/migrate-crm-card.md): Swaps a Legacy CRM Card with an App Card in views. Reference the "Migrate a legacy CRM card to an app card" docs for more information - [Update a card](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/update-crm-card.md): Update a card definition with new details. - [Delete a card](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/crm-cards/delete-crm-card.md): Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone. #### Transcriptions - [Create a transcript](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/transcriptions/create-transcript.md): Create a new transcript for a call in your HubSpot account. This endpoint allows you to submit the details of a call transcript, including engagement ID and utterances, to be stored and managed within HubSpot. This is useful for integrating call transcription data into your CRM workflows. - [Retrieve a transcript](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/transcriptions/get-transcript.md): Retrieve a specific call transcript by its unique identifier. This endpoint allows you to access the details of a transcript, including its creation and update timestamps, engagement ID, source, and the transcript utterances. It is useful for reviewing and analyzing call interactions stored in your… - [Transcribe inbound call](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/transcriptions/transcribe-inbound.md): This endpoint processes inbound calls by accepting a request with details about the call. It requires a JSON payload containing information such as the call's external ID, final status, and phone numbers involved. This operation is useful for integrating third-party call data into HubSpot, allowing… - [Delete a transcript](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/transcriptions/delete-transcript.md): Delete a specific call transcript from your HubSpot account using its unique identifier. This operation is useful for managing and cleaning up transcript data that is no longer needed. #### Video conferencing extension - [Video conference extension](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/video-conferencing-extension/guide.md): These endpoints are used to plug into the meeting creation flow within HubSpot and add video conference information. - [Get settings](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/video-conferencing-extension/get-video-conferencing-extension.md): Fetch video conference extension settings for your app - [Create or update settings](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/video-conferencing-extension/update-video-conferencing-extension.md): Create or update video conference extension settings for your app - [Delete settings](https://developers.hubspot.com/docs/api-reference/latest/crm/extensions/video-conferencing-extension/delete-video-conferencing-extension.md): Delete video conference extension settings for your app ### Imports - [Imports API](https://developers.hubspot.com/docs/api-reference/latest/crm/imports/guide.md): Imports are used to populate a HubSpot account with object data that can be used with the sales, marketing, and service tools. - [Cancel an active import](https://developers.hubspot.com/docs/api-reference/latest/crm/imports/cancel-import.md): This allows a developer to cancel an active import. - [Start an import](https://developers.hubspot.com/docs/api-reference/latest/crm/imports/create-import.md): Create a new import in your HubSpot account by uploading files and specifying import settings. This endpoint allows you to initiate the import process by providing the necessary files and configuration details. - [Retrieve errors for a specific import](https://developers.hubspot.com/docs/api-reference/latest/crm/imports/get-import-errors.md): Retrieves detailed error records for a specific import operation, enabling you to identify and troubleshoot records that failed during processing. - [Get the information on any import](https://developers.hubspot.com/docs/api-reference/latest/crm/imports/get-import.md): A complete summary of an import record, including any updates. - [Retrieve imports](https://developers.hubspot.com/docs/api-reference/latest/crm/imports/get-imports.md): Retrieve a list of imports in your HubSpot account. This endpoint allows you to view the imports that have been processed, providing details about each import. It supports pagination to navigate through large sets of import data. ### Limits Tracking - [Limits Tracking API](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/guide.md): Learn how to view an account's usage and limits for CRM data such as records, associations, pipelines, and properties. - [Read calculation property limits](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-calculated-properties.md): Returns overall limit and per object usage for calculated properties - [Read custom object limits](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-custom-object-types.md): Returns limits and usage for custom object schemas - [Read custom property limits](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-custom-properties.md): Returns limits and usage per object for custom properties - [Read record association limits](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-from.md): Returns objects with records approaching or at association limits - [Read record association limits from an object](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-limits-tracking-fromObjectTypeId.md): Returns objects for which the from object has records approaching or at association limits - [Read record association limits between two objects](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-limits-tracking-toObjectTypeId.md): Returns records approaching or at association limits between two objects - [Read association label limits](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-limits-tracking.md): Returns limits and usage for custom association labels - [Read pipeline limits](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-pipelines.md): Returns limits and usage per object for pipelines - [Read record limits](https://developers.hubspot.com/docs/api-reference/latest/crm/limits-tracking/get-records.md): Returns limits and usage per object for records ### Segments (Lists) - [Segments API](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/guide.md): Retrieve, create, and manage segments (lists). - [Create List](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/create-list.md): Create a new list in your HubSpot account using the specified parameters. This endpoint allows you to define the properties and criteria for the list, which can be used for organizing and managing contacts or other CRM objects. - [List all](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/get-all-lists.md): Retrieve all lists in the CRM system. This endpoint allows you to fetch a comprehensive list of all available lists, which can be useful for managing and organizing your CRM data effectively. - [Retrieve segment size and edits history](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/get-list-history.md): Retrieve the size and edits history of a specific list within a defined date range. This endpoint is useful for tracking changes and understanding the evolution of list size over time. - [Retrieve list](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/get-list-listId.md): Retrieve details of a specific list in your HubSpot account using the list's unique identifier. This endpoint allows you to optionally include filters associated with the list in the response. - [Retrieve List](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/get-list.md): Retrieve a specific list by its name and object type ID in your HubSpot account. This endpoint allows you to access the details of a list, which can be useful for managing and analyzing your CRM data. You can also choose to include filters in the response. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/get-lists.md): Retrieve a list of CRM lists in your HubSpot account. This endpoint allows you to filter the lists by their IDs and optionally include filters applied to the lists. It is useful for managing and organizing your CRM data by accessing specific lists. - [Restore](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/restore-list.md): Restore a previously deleted list in your HubSpot account. This operation allows you to recover lists that have been removed, ensuring that any associated data or configurations are reinstated. This can be useful for retrieving lists that were mistakenly deleted or are needed again for ongoing opera… - [Update list name](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/update-list-name.md): Update the name of a specific list in your HubSpot account. This endpoint allows you to change the list's name by specifying the new name as a query parameter. It is useful for keeping your lists organized and up-to-date with relevant titles. - [Delete](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/delete-list.md): Delete a specific list in your HubSpot account using its unique identifier. This operation will permanently remove the list and its associated data, ensuring it is no longer accessible. #### Filters - [Segment (list) filters overview](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/filters/guide.md): Learn how to structure filters when using the Lists API - [Update list filters](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/filters/update-list-filters.md): Update the filters for a specific list in your HubSpot account. This operation allows you to modify the criteria used to include objects in the list. You can also specify whether objects should be enrolled in workflows based on the updated filters. #### ID Mapping - [Map IDs](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/id-mapping/translate-id-batch.md): Map legacy list IDs to their corresponding new IDs in the HubSpot system. This endpoint is useful for migrating data from older systems to the current HubSpot structure, ensuring that all list references are updated correctly. - [Retrieve ID Mapping](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/id-mapping/translate-id.md): Retrieve the mapping of legacy list IDs to their current IDs in the HubSpot system. This endpoint is useful for migrating or updating systems that rely on legacy list identifiers. #### List Management - [Cancel the conversion of a segment](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/cancel-conversion.md): Delete a scheduled conversion for a specific list in your HubSpot account. This operation is useful when you need to cancel a previously scheduled conversion for a list identified by its listId. - [Create Folder](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/create-folder.md): Create a new folder within the CRM lists in your HubSpot account. This operation allows you to organize your lists into folders for better management and accessibility. - [Retrieve the conversion details for a segment](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/get-conversion-details.md): Retrieve the scheduled conversion details for a specific list in your HubSpot account. This endpoint provides information about any scheduled conversions for the specified list, allowing you to manage and track list conversions effectively. - [List folders](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/get-folder.md): Retrieve a list of folders within the CRM lists. This endpoint can be used to navigate through the folder structure by specifying a folder ID. It is useful for organizing and managing lists within folders. - [Move Folder](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/move-folder.md): Move a folder to a new parent folder within the CRM lists. This operation is useful for reorganizing your folder structure by changing the parent folder of a specified folder. - [Move List](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/move-list-to-folder.md): Move a list to a different folder within your HubSpot account. This operation requires specifying the list and the target folder. It is useful for organizing lists into different categories or structures. - [Rename folder](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/rename-folder.md): Rename an existing folder in the CRM lists by specifying the folder's ID and the new desired name. This can be useful for organizing and updating folder structures within your account. - [Schedule or update the conversion of a segment to static](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/schedule-conversion.md): Schedule a conversion for a specific list in your HubSpot account. This operation allows you to set a conversion time for the list identified by the listId. Use this endpoint to manage the conversion schedule of your lists effectively. - [Delete folder](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/list-management/delete-folder.md): Delete a specific folder within the CRM lists by providing the folder's unique identifier. This operation is useful for removing folders that are no longer needed or to clean up the folder structure within your CRM lists. #### Memberships - [Add memberships](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/add-to-list-from-source-list.md): Add memberships to a specified list from another source list. This operation is useful for consolidating list memberships by transferring members from one list to another. The endpoint does not return any content upon successful execution. - [Add memberships](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/add-to-list.md): Add memberships to a specified list in your HubSpot account. This endpoint allows you to add multiple memberships to a list identified by the listId. It is useful for managing list memberships in bulk, ensuring that the specified records are included in the list. - [Retrieve memberships](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/get-lists-per-record.md): Retrieve the list memberships for a specific record within a specified object type. This endpoint is useful for understanding which lists a particular record is a member of, based on the object type and record ID provided. - [Batch read memberships](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/get-memberships-batch.md): Retrieve batch membership information for records within specified lists. This endpoint is useful for obtaining membership details in bulk, allowing for efficient data retrieval when dealing with multiple records. - [Fetch segment memberships ordered by added to segment date](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/get-memberships-by-added-date.md): Retrieve the join order of memberships for a specific list in your HubSpot account. This endpoint allows you to view the order in which records joined the list, which can be useful for tracking membership changes over time. - [List memberships](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/get-memberships-by-id.md): Retrieve the memberships of a specific list in your HubSpot account. This endpoint allows you to paginate through the list memberships using cursor-based pagination. It is useful for obtaining detailed membership information for a given list. - [Remove segment memberships](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/remove-from-list.md): Remove memberships from a specific list in your HubSpot account. This operation is useful for managing list memberships by removing specified records from the list. The request requires a list of record IDs to be removed from the specified list. - [Update segment membership](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/update-list-memberships.md): Update the memberships of a list by adding and removing members in a single operation. This endpoint allows you to efficiently manage list memberships by specifying which members to add and which to remove in one request. - [Delete all records from a segment](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/memberships/delete-list-listId.md): Delete all memberships associated with a specific list in your HubSpot account. This operation is useful when you need to remove all members from a list, effectively clearing its membership data. #### Search - [Search Lists](https://developers.hubspot.com/docs/api-reference/latest/crm/lists/search/search-lists.md): Search for lists within your HubSpot account using various criteria. This endpoint allows you to filter and retrieve lists based on specific search parameters, making it easier to manage and organize your lists effectively. ### Owners - [Owners API](https://developers.hubspot.com/docs/api-reference/latest/crm/owners/guide.md): HubSpot uses owners to assign CRM objects to specific people. These endpoints are used to get a list of available owners for an account. - [Retrieve an owner](https://developers.hubspot.com/docs/api-reference/latest/crm/owners/get-owner.md): Retrieve details of a specific owner using either their 'id' or 'userId'. - [Retrieve all owners](https://developers.hubspot.com/docs/api-reference/latest/crm/owners/get-owners.md): Retrieve a paginated list of owners from your HubSpot account. This endpoint allows filtering by email and supports pagination through the 'after' parameter. You can also specify the maximum number of results per page and choose to include archived owners in the response. ### Pipelines - [Pipelines API](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/guide.md): Create, read, update, or delete object pipelines and pipeline stages. - [Create pipeline](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/create-pipeline.md): Create a new pipeline for a specified object type in your HubSpot account. This endpoint requires a JSON request body with details about the pipeline, including its label, display order, and stages. The operation returns the newly created pipeline's details upon success. - [Retrieve pipeline](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/get-pipeline.md): Retrieve detailed information about a specific pipeline in your HubSpot account. This endpoint allows you to access the properties and stages of the pipeline identified by the given pipelineId and objectType. It is useful for obtaining the current configuration and status of a pipeline. - [Retrieve audit logs](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/get-pipelines-audit.md): Retrieve audit logs for a specific pipeline in your HubSpot account. This endpoint provides detailed information about changes made to the specified pipeline, which can be useful for tracking modifications and understanding the history of the pipeline's configuration. - [Retrieve pipelines](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/get-pipelines.md): Retrieve all pipelines for a specified object type in your HubSpot account. This endpoint allows you to access pipeline information without paging, making it useful for obtaining a complete list of pipelines associated with a particular object type. - [Update pipeline (Partial)](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/partially-update-pipeline.md): Update an existing pipeline in your HubSpot account. This endpoint allows you to modify specific properties of a pipeline, such as its label, display order, or archived status. Use this to keep your pipeline data up-to-date and organized. - [Update pipeline (Replace)](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/update-pipeline.md): Update an existing pipeline in your HubSpot account by specifying the pipeline ID and object type. This operation allows you to modify the pipeline's properties, such as its label, display order, and stages. Ensure that the request body contains the necessary fields for a successful update. - [Delete pipeline](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/delete-pipeline.md): Delete a specific pipeline in your HubSpot account identified by its object type and pipeline ID. This operation can optionally validate references and deal stage usages before deletion to ensure data integrity. #### Rules - [Pipeline Rules API](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/guide.md): Manage validation rules, approvals, and stage permissions for CRM object pipelines. - [Retrieve Approval](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/get-pipeline-approvals.md): Retrieve the approval status of a specific object within a pipeline. This endpoint is useful for checking the current approval state of an object, which can be critical in workflows that require validation or authorization steps. - [Retrieve rules](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/get-pipeline-permissions.md): Retrieve the rules associated with a specific pipeline in your HubSpot account. This endpoint allows you to access governance validation rules and approval stages for the specified pipeline. It is useful for understanding the constraints and approval processes applied to the pipeline. - [Retrieve permissions](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/get-pipeline-stage-permissions.md): Retrieve the stage edit permissions for a specific pipeline in your HubSpot account. This endpoint allows you to view the permissions set for editing stages within a given pipeline, identified by its object type and pipeline ID. This can be useful for managing access and ensuring that only authorize… - [Update rules (Partial)](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/partially-update-pipeline-rules.md): Update the rules for a specific pipeline within a given object type in HubSpot. This operation allows you to modify governance validation rules and approval stages for the specified pipeline. It is useful for maintaining or altering the workflow rules associated with your pipelines. - [Start Approval](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/start-pipeline-approval.md): Initiate the approval process for a specific pipeline within a given object type. This endpoint is useful for triggering approval workflows that are associated with pipeline stages, ensuring that the necessary approvals are obtained before proceeding with further actions in the pipeline. - [Update rules (Replace)](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/update-pipeline-rules.md): Update the rules for a specific pipeline in your HubSpot account. This endpoint allows you to modify governance validation rules and approval stages associated with a pipeline. It requires specifying the object type and pipeline identifiers. - [Delete](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/rules/delete-pipeline-rules.md): Delete a specific set of pipeline rules associated with a given object type and pipeline ID in your HubSpot account. This operation is useful for removing obsolete or incorrect rules from a pipeline. Ensure that the objectTypeId and pipelineId are correctly specified to avoid unintended deletions. #### Stages - [Create Stage](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/stages/create-pipeline-stage.md): Create a new stage within a specified pipeline for a given object type in HubSpot. This endpoint is useful for adding new stages to a pipeline, allowing for more granular tracking and management of objects through different stages of a process. - [Retrieve stage](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/stages/get-pipeline-stage.md): Retrieve details of a specific stage within a pipeline for a given object type in HubSpot. This endpoint is useful for accessing information about a particular stage, such as its label, display order, and metadata, which can be used for managing or analyzing pipeline stages. - [Retrieve stage audit](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/stages/get-pipelines-stage-audit.md): Retrieve the audit information for a specific stage within a pipeline in your HubSpot account. This endpoint provides details about actions taken on the specified stage, which can be useful for tracking changes and understanding the history of modifications. - [Update stage](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/stages/update-pipeline-stage.md): Update a specific stage within a pipeline for a given object type in HubSpot. This endpoint allows you to modify the details of a stage, such as its label, display order, and metadata. Use this to keep your pipeline stages up-to-date and aligned with your business processes. - [Delete stage](https://developers.hubspot.com/docs/api-reference/latest/crm/pipelines/stages/delete-pipeline-stage.md): Delete a specific stage from a pipeline in your HubSpot account. This operation is useful for managing and maintaining your pipeline stages by removing those that are no longer needed. Ensure that any references to the stage are handled appropriately before deletion. ### Properties - [Properties API](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/guide.md): The CRM properties endpoints allow you to manage custom properties as well as view default property details for any object. - [Create a property](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/create-property.md): Create and return a copy of a new property for the specified object type. - [Read all properties](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/get-properties.md): Read all existing properties for the specified object type and HubSpot account. - [Read a property](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/get-property.md): Read a property identified by {propertyName}. - [Access and manage Sensitive Data](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/sensitive-data.md): Learn how to gain access to and manage Sensitive Data via API. - [Update a property](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/update-property.md): Perform a partial update of a property identified by { propertyName }. Provided fields will be overwritten. - [Archive a property](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/delete-property.md): Move a property identified by {propertyName} to the recycling bin. #### Batch - [Create a batch of properties](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/batch/create-properties.md): Create a batch of properties using the same rules as when creating an individual property. - [Read a batch of properties](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/batch/get-properties.md): Read a provided list of properties. - [Archive a batch of properties](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/batch/delete-properties.md): Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent). #### Property groups - [Create a property group](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/property-groups/create-property.md): Create and return a copy of a new property group. - [Read all property groups](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/property-groups/get-properties.md): Read all existing property groups for the specified object type and HubSpot account. - [Read a property group](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/property-groups/get-property.md): Read a property group identified by {groupName}. - [Update a property group](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/property-groups/update-property.md): Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten. - [Archive a property group](https://developers.hubspot.com/docs/api-reference/latest/crm/properties/property-groups/delete-property.md): Move a property group identified by {groupName} to the recycling bin. ### Property Validations - [Property Validations API](https://developers.hubspot.com/docs/api-reference/latest/crm/property-validations/guide.md): The property validations endpoints allow you to view, create, and update validation rules for your properties. - [Read validation rules for a property](https://developers.hubspot.com/docs/api-reference/latest/crm/property-validations/get-property-validation.md): Read a property's validation rules identified by {propertyName}. - [Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted.](https://developers.hubspot.com/docs/api-reference/latest/crm/property-validations/get-property-validations-ruleType.md): Retrieve a specific validation rule for a property identified by its name and rule type. - [Read all property validation rules for an object](https://developers.hubspot.com/docs/api-reference/latest/crm/property-validations/get-property-validations.md): Read all properties with validation rules for a given object. - [Update a validation rule for a specific property and rule type, allowing customization of property value constraints.](https://developers.hubspot.com/docs/api-reference/latest/crm/property-validations/update-property-validation.md): Update a specific validation rule for a property identified by its name and rule type. ## OpenAPI Specs - [crm-calls-v2026-09](/docs/specs/2026-09/crm-calls-v2026-09.json) - [crm-emails-v2026-09](/docs/specs/2026-09/crm-emails-v2026-09.json) - [crm-meetings-v2026-09](/docs/specs/2026-09/crm-meetings-v2026-09.json) - [crm-notes-v2026-09](/docs/specs/2026-09/crm-notes-v2026-09.json) - [crm-postal-mail-v2026-09](/docs/specs/2026-09/crm-postal-mail-v2026-09.json) - [crm-tasks-series-v2026-09](/docs/specs/2026-09/crm-tasks-series-v2026-09.json) - [crm-tasks-v2026-09](/docs/specs/2026-09/crm-tasks-v2026-09.json) - [crm-associations-v2026-09](/docs/specs/2026-09/crm-associations-v2026-09.json) - [crm-associations-schema-v2026-09](/docs/specs/2026-09/crm-associations-schema-v2026-09.json) - [crm-object-library-v2026-09](/docs/specs/2026-09/crm-object-library-v2026-09.json) - [crm-exports-v2026-09](/docs/specs/2026-09/crm-exports-v2026-09.json) - [crm-calling-extensions-v2026-09](/docs/specs/2026-09/crm-calling-extensions-v2026-09.json) - [crm-public-app-crm-cards-v2026-09](/docs/specs/2026-09/crm-public-app-crm-cards-v2026-09.json) - [crm-transcriptions-v2026-09](/docs/specs/2026-09/crm-transcriptions-v2026-09.json) - [crm-video-conferencing-extension-v2026-09](/docs/specs/2026-09/crm-video-conferencing-extension-v2026-09.json) - [crm-imports-v2026-09](/docs/specs/2026-09/crm-imports-v2026-09.json) - [crm-limits-tracking-v2026-09](/docs/specs/2026-09/crm-limits-tracking-v2026-09.json) - [crm-lists-v2026-09](/docs/specs/2026-09/crm-lists-v2026-09.json) - [crm-appointments-v2026-09](/docs/specs/2026-09/crm-appointments-v2026-09.json) - [crm-carts-v2026-09](/docs/specs/2026-09/crm-carts-v2026-09.json) - [crm-commerce-payments-v2026-09](/docs/specs/2026-09/crm-commerce-payments-v2026-09.json) - [crm-commerce-subscriptions-v2026-09](/docs/specs/2026-09/crm-commerce-subscriptions-v2026-09.json) - [crm-communications-v2026-09](/docs/specs/2026-09/crm-communications-v2026-09.json) - [crm-companies-v2026-09](/docs/specs/2026-09/crm-companies-v2026-09.json) - [crm-contacts-v2026-09](/docs/specs/2026-09/crm-contacts-v2026-09.json) - [crm-contracts-v2026-09](/docs/specs/2026-09/crm-contracts-v2026-09.json) - [crm-courses-v2026-09](/docs/specs/2026-09/crm-courses-v2026-09.json) - [crm-custom-objects-v2026-09](/docs/specs/2026-09/crm-custom-objects-v2026-09.json) - [crm-deal-splits-v2026-09](/docs/specs/2026-09/crm-deal-splits-v2026-09.json) - [crm-deals-v2026-09](/docs/specs/2026-09/crm-deals-v2026-09.json) - [crm-discounts-v2026-09](/docs/specs/2026-09/crm-discounts-v2026-09.json) - [crm-feedback-submissions-v2026-09](/docs/specs/2026-09/crm-feedback-submissions-v2026-09.json) - [crm-fees-v2026-09](/docs/specs/2026-09/crm-fees-v2026-09.json) - [crm-forecast-types-v2026-09](/docs/specs/2026-09/crm-forecast-types-v2026-09.json) - [crm-forecasts-v2026-09](/docs/specs/2026-09/crm-forecasts-v2026-09.json) - [crm-goal-targets-v2026-09](/docs/specs/2026-09/crm-goal-targets-v2026-09.json) - [crm-invoices-v2026-09](/docs/specs/2026-09/crm-invoices-v2026-09.json) - [crm-leads-v2026-09](/docs/specs/2026-09/crm-leads-v2026-09.json) - [crm-line-items-v2026-09](/docs/specs/2026-09/crm-line-items-v2026-09.json) - [crm-listings-v2026-09](/docs/specs/2026-09/crm-listings-v2026-09.json) - [crm-object-tags-v2026-09](/docs/specs/2026-09/crm-object-tags-v2026-09.json) - [crm-objects-v2026-09](/docs/specs/2026-09/crm-objects-v2026-09.json) - [crm-orders-v2026-09](/docs/specs/2026-09/crm-orders-v2026-09.json) - [crm-partner-clients-v2026-09](/docs/specs/2026-09/crm-partner-clients-v2026-09.json) - [crm-partner-services-v2026-09](/docs/specs/2026-09/crm-partner-services-v2026-09.json) - [crm-price-book-items-crm-reads-api-v2026-09](/docs/specs/2026-09/crm-price-book-items-crm-reads-api-v2026-09.json) - [crm-price-books-crm-reads-api-v2026-09](/docs/specs/2026-09/crm-price-books-crm-reads-api-v2026-09.json) - [crm-products-v2026-09](/docs/specs/2026-09/crm-products-v2026-09.json) - [crm-projects-v2026-09](/docs/specs/2026-09/crm-projects-v2026-09.json) - [crm-quotes-v2026-09](/docs/specs/2026-09/crm-quotes-v2026-09.json) - [crm-schemas-v2026-09](/docs/specs/2026-09/crm-schemas-v2026-09.json) - [crm-services-v2026-09](/docs/specs/2026-09/crm-services-v2026-09.json) - [crm-taxes-v2026-09](/docs/specs/2026-09/crm-taxes-v2026-09.json) - [crm-tickets-v2026-09](/docs/specs/2026-09/crm-tickets-v2026-09.json) - [crm-users-v2026-09](/docs/specs/2026-09/crm-users-v2026-09.json) - [crm-crm-owners-v2026-09](/docs/specs/2026-09/crm-crm-owners-v2026-09.json) - [crm-pipelines-v2026-09](/docs/specs/2026-09/crm-pipelines-v2026-09.json) - [crm-pipeline-governance-v2026-09](/docs/specs/2026-09/crm-pipeline-governance-v2026-09.json) - [crm-properties-v2026-09](/docs/specs/2026-09/crm-properties-v2026-09.json) - [crm-property-validations-v2026-09](/docs/specs/2026-09/crm-property-validations-v2026-09.json)