# HubSpot docs: APIs 2026-09 CRM Objects ## Objects - [APIs / 2026-09 / CRM / Objects / Communications (13 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/communications.txt): Documentation for APIs / 2026-09 / CRM / Objects / Communications. - [APIs / 2026-09 / CRM / Objects / Courses (14 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/courses.txt): Documentation for APIs / 2026-09 / CRM / Objects / Courses. - [APIs / 2026-09 / CRM / Objects / Custom Objects (13 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/custom-objects.txt): Documentation for APIs / 2026-09 / CRM / Objects / Custom Objects. - [APIs / 2026-09 / CRM / Objects / Invoices (14 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/invoices.txt): Documentation for APIs / 2026-09 / CRM / Objects / Invoices. - [APIs / 2026-09 / CRM / Objects / Listings (13 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/listings.txt): Documentation for APIs / 2026-09 / CRM / Objects / Listings. - [APIs / 2026-09 / CRM / Objects / Orders (15 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/orders.txt): Documentation for APIs / 2026-09 / CRM / Objects / Orders. - [APIs / 2026-09 / CRM / Objects / Services (14 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/services.txt): Documentation for APIs / 2026-09 / CRM / Objects / Services. - [APIs / 2026-09 / CRM / Objects / Tickets (15 pages)](https://developers.hubspot.com/docs/_llms/apis/2026-09/crm/objects/tickets.txt): Documentation for APIs / 2026-09 / CRM / Objects / Tickets. ### Appointments - [Appointments API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/guide.md): Use the appointments API to manage appointments in the HubSpot CRM. - [Appointment object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/object-definition.md): Information about the Appointment object, including identifiers, feature support, and default properties. - [Create appointment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/create-appointment.md): Create a appointment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard appointments is provided. - [Retrieve appointment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/get-appointment.md): Read an Object identified by `{appointmentId}`. `{appointmentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve appointments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/get-appointments.md): Read a page of appointments. Control what is returned via the `properties` query param. - [Update appointment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/update-appointment.md): Perform a partial update of an Object identified by `{appointmentId}`or optionally a unique property value as specified by the `idProperty` query param. `{appointmentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for th… - [Delete appointment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/delete-appointment.md): Move an Object identified by `{appointmentId}` to the recycling bin. #### Batch - [Create a batch of appointments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/batch/create-appointments.md): Create multiple appointments in a single request. - [Read a batch of appointments by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/batch/get-appointments.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of appointments by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/batch/update-appointments.md): Update a batch of CRM objects of a specified type in HubSpot. This endpoint allows you to modify multiple objects in a single request, making it efficient for bulk updates. The request body must include the objects and their properties to be updated. - [Create or update a batch of appointments by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/batch/upsert-appointments.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 a batch of appointments by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/batch/delete-appointments.md): Archive multiple appointments using their IDs. #### Merge - [Merge two appointments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/merge/merge-appointments.md): Merge two object types together #### Search - [Search for appointments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/appointments/search/search-appointments.md): Search for appointments based on specified criteria. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request). ### Carts - [Carts API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/guide.md): Create and manage ecommerce cart data. - [Cart object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/object-definition.md): Information about the Cart object, including identifiers, feature support, and default properties. - [Create a cart](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/create-cart.md): Create a CRM object with the specified properties and receive a copy of the object, including its ID. This endpoint is useful for adding new objects to your CRM system with predefined properties. Documentation and examples for creating standard objects are provided. - [Retrieve a cart](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/get-cart.md): Read an object identified by `{objectId}`. By default, `{objectId}` refers to the internal object ID, but it can also refer to any unique property value specified by the `idProperty` query parameter. You can control the response content using the `properties` query parameter to specify which propert… - [Retrieve all carts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/get-carts.md): Read a page of objects of the specified type. You can control the data returned by specifying the properties you want to include in the response. This endpoint is useful for retrieving a list of CRM objects with optional filtering and pagination capabilities. - [Update a cart](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/update-cart.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 a cart](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/delete-cart.md): Move an Object identified by `{objectId}` to the recycling bin. This operation is useful for temporarily removing objects without permanently deleting them, allowing for potential recovery or review before final deletion. #### Batch - [Create carts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/batch/create-carts.md): Create a batch of CRM objects in your HubSpot account. This endpoint allows you to create multiple objects at once by specifying their properties. The response will include a copy of each created object, including their IDs. This is useful for efficiently adding large sets of data to your CRM. - [Retrieve carts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/batch/get-carts.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 carts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/batch/update-carts.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 where you need to change information across several records simultaneously. - [Upsert carts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/batch/upsert-carts.md): Create or update a batch of CRM objects by unique property values. This operation allows you to either insert new objects or update existing ones based on the provided unique identifiers. It is useful for bulk operations where you need to ensure that objects are up-to-date or added if they do not ex… - [Archive carts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/batch/delete-carts.md): Archive a batch of CRM objects identified by their IDs. This operation moves the specified objects to the recycling bin, effectively archiving them in bulk. It is useful for managing large sets of data that need to be archived simultaneously. #### Search - [Search for carts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/carts/search/search-carts.md): Search CRM objects of a specified type using various filters and criteria. This endpoint allows you to query CRM objects by specifying filter groups, sorting options, and properties to include in the response. It is useful for retrieving a customized list of objects based on specific search paramete… ### Commerce Payments - [Payments API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/guide.md): Retrieve information about payments. - [Commerce payment object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/object-definition.md): Information about the Commerce payment object, including identifiers, feature support, and default properties. - [Create a payment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/create-commerce-payment.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. Documentation and examples for creating standard objects are provided. - [Retrieve a payment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/get-commerce-payment.md): Read an object identified by `objectId`. By default, `objectId` refers to the internal object ID, but you can specify a unique property value using the `idProperty` query parameter. You can control the response content using the `properties` query parameter to include specific properties. - [Retrieve payments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/get-commerce-payments.md): Retrieve a page of CRM objects of a specified type. You can control the data returned by specifying properties, associations, and archived status. This endpoint is useful for fetching a list of objects with specific attributes and associations. - [Update a payment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/update-commerce-payment.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 a payment](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/delete-commerce-payment.md): Move an Object identified by `{objectId}` to the recycling bin. This operation effectively archives the object, making it no longer active but retrievable if needed. #### Batch - [Create payments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/batch/create-commerce-payments.md): Create a batch of CRM objects with the specified properties. This endpoint allows you to efficiently create multiple objects in a single request, returning a response that includes the details of the created objects. It's useful for bulk data operations where you need to add several objects at once. - [Retrieve payments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/batch/get-commerce-payments.md): Read a batch of CRM objects by their internal IDs or unique property values. This endpoint allows you to retrieve multiple objects in a single request, making it efficient for bulk data retrieval. It supports filtering for archived objects. - [Update payments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/batch/update-commerce-payments.md): Update a batch of CRM objects in your HubSpot account. This endpoint allows you to modify multiple objects of a specified type in a single request. It is useful for bulk updates, ensuring that all specified objects are updated consistently and efficiently. - [Upsert payments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/batch/upsert-commerce-payments.md): Create or update a batch of CRM objects by unique property values. This endpoint allows you to efficiently manage multiple objects in one request, ensuring that existing objects are updated and new ones are created as needed. - [Delete payments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/batch/delete-commerce-payments.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, streamlining the process of managing large datasets. #### Search - [Search for payments](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-payments/search/search-commerce-payments.md): Search for CRM objects of a specified type using the provided search criteria. This endpoint allows you to filter and sort objects based on various properties, making it useful for retrieving specific data sets from your CRM. ### Commerce Subscriptions - [Subscriptions API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/guide.md): Retrieve information about subscriptions. - [Commerce subscription object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/object-definition.md): Information about the Subscription object, including identifiers, feature support, and default properties. - [Create a subscription](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/create-commerce-subscription.md): Create a new subscription object with specified properties and optional associations. - [Retrieve a subscription](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/get-commerce-subscription.md): Retrieve a specific subscription by its ID, including its properties and associations. - [Retrieve subscriptions](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/get-commerce-subscriptions.md): Retrieve a list of subscription objects, with options to filter by properties, associations, and archived status. - [Update a subscription](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/update-commerce-subscription.md): Update a specific subscription by its ID with new property values. - [Delete a subscription](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/delete-commerce-subscription.md): Delete a specific subscription by its ID. #### Batch - [Create subscriptions](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/batch/create-commerce-subscriptions.md): Create multiple subscription objects in a single batch operation, allowing for efficient data entry and management. - [Retrieve subscriptions](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/batch/get-commerce-subscriptions.md): Retrieve a batch of CRM subscription objects by their IDs, including specified properties and their histories. - [Update subscriptions](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/batch/update-commerce-subscriptions.md): Update multiple subscription objects in a single batch operation, allowing for efficient modifications of CRM subscription records. - [Upsert subscriptions](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/batch/upsert-commerce-subscriptions.md): This endpoint allows you to perform a batch upsert operation on subscription objects, which will either update existing records or create new ones if they do not already exist. The operation returns the status, timestamps, and a list of successfully processed objects. - [Archive multiple subscriptions](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/batch/delete-commerce-subscriptions.md): Archive a batch of subscription objects by providing their IDs in the request body. #### Search - [Search for subscriptions](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/commerce-subscriptions/search/search-commerce-subscriptions.md): Execute a search for CRM commerce subscriptions based on defined filters, properties, and sorting options. This endpoint allows for complex queries to retrieve specific subscription data, supporting pagination and a variety of search parameters. ### Companies - [Companies API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/guide.md): Company records store data about businesses. The companies endpoints allow you to manage this data and sync it between HubSpot and other systems. - [Company object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/object-definition.md): Information about the Company object, including identifiers, feature support, and default properties. - [Create a company](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/create-company.md): Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-… - [Retrieve companies](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/get-companies.md): Retrieve all companies, using query parameters to control the information that gets returned. - [Retrieve a company](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/get-company.md): Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter. - [Merge two companies](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/merge-companies.md): Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). - [Update a company](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/update-company.md): Update a company by ID (`companyId`) 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. - [Archive a company](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/delete-company.md): Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records). #### Batch - [Create a batch of companies](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/batch/create-companies.md): Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. - [Retrieve a batch of companies](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/batch/get-companies.md): Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter. - [Update a batch of companies](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/batch/update-companies.md): Update a batch of companies by ID. - [Create or update a batch of companies by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/batch/upsert-companies.md): Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object. - [Archive a batch of companies](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/batch/delete-companies.md): Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records). #### Search - [Search for companies](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/companies/search/search-companies.md): Search for companies 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). ### Contacts - [Contacts API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/guide.md): Contact records store information about individuals. The contacts endpoints allow you to manage this data and sync it between HubSpot and other systems. - [Contact object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/object-definition.md): Information about the Contact object, including identifiers, feature support, and default properties. - [Create a contact](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/create-contact.md): Create a single contact. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the contact, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-… - [Retrieve a contact](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/get-contact.md): Retrieve a contact by its ID (`contactId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter. - [Retrieve contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/get-contacts.md): Retrieve all contacts, using query parameters to specify the information that gets returned. - [Merge two contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/merge-contacts.md): Merge two contact records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). - [Update a contact](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/update-contact.md): Update an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query pa… - [Delete a contact](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/delete-contact.md): Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowle… #### Batch - [Create contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/batch/create-contacts.md): Create a batch of contacts. 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 contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/batch/get-contacts.md): Retrieve a batch of contacts by ID (`contactId`) or unique property value (`idProperty`). - [Update contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/batch/update-contacts.md): Update a batch of contacts by ID (`contactId`) 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 contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/batch/upsert-contacts.md): Upsert a batch of contacts. The `inputs` array can contain a `properties` object to define property values for each record. - [Delete contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/batch/delete-contacts.md): Archive a batch of contacts by ID. Archived contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](ht… #### Search - [Search for contacts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contacts/search/search-contacts.md): Search for contacts 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). ### Contracts - [Contracts API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contracts/guide.md): Create and manage contract CRM records in HubSpot. - [Retrieve contract](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contracts/get-contract.md): Read an Object identified by `{contractId}`. `{contractId}` 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. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contracts/get-contracts.md): Read a page of contracts. Control what is returned via the `properties` query param. #### Batch - [Batch retrieve contracts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/contracts/batch/get-contracts.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ### Deal Splits - [Deal Splits API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deal-splits/guide.md): Learn how to view and edit deal splits via API. - [Retrieve deal splits](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deal-splits/get-deal-splits.md): Read a batch of deal split objects by their associated deal object internal ID - [Upsert deal splits](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deal-splits/upsert-deal-splits.md): Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places ### Deals - [Deals API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/guide.md): A deal stores data about an ongoing transaction. The deals endpoints allow you to manage this data and sync it between HubSpot and other systems. - [Deal object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/object-definition.md): Information about the Deal object, including identifiers, feature support, and default properties. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/create-deal.md): Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/get-deal.md): Read an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/get-deals.md): Read a page of deals. Control what is returned via the `properties` query param. - [Merge two deals with same type](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/merge-deals.md): Combine two deals of the same type into a single deal. - [Search for deals using various filters and criteria to retrieve specific records.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/search-deals.md): Search for deals using specified criteria and filters. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/update-deal.md): Perform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Prov… - [Archive](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/delete-deal.md): Move an Object identified by `{dealId}` to the recycling bin. #### Batch - [Create a batch of deals](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/batch/create-deals.md): Create multiple deals in a single request. - [Read a batch of deals by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/batch/get-deals.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of deals by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/batch/update-deals.md): Update multiple deals using their internal IDs or unique property values. - [Create or update a batch of deals by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/batch/upsert-deals.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 a batch of deals by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/deals/batch/delete-deals.md): Archive multiple deals using their IDs. ### Discounts - [Discounts API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/guide.md): Learn how to create and associate a discount as part of the pricing details of a quote. - [Discount object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/object-definition.md): Information about the Discount object, including identifiers, feature support, and default properties. - [Create a discount](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/create-discount.md): Create a CRM object with the specified properties and receive a copy of the object, including its ID. This endpoint is useful for adding new objects to your CRM system and ensures that you receive the newly created object's details immediately. - [Retrieve a discount](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/get-discount.md): Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve discounts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/get-discounts.md): Read a page of objects of a specified type in your HubSpot account. You can control the data returned by specifying certain properties, associations, and whether to include archived records. This endpoint supports pagination through the use of a cursor token. - [Update a discount](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/update-discount.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 a discount](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/delete-discount.md): Move an object identified by `{objectId}` to the recycling bin. This operation allows you to archive an object of a specified type, effectively removing it from active use while retaining it in the system for potential future restoration. #### Batch - [Create discounts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/batch/create-discounts.md): Create a batch of CRM objects with specified properties in your HubSpot account. This endpoint allows you to efficiently create multiple objects in a single request, returning a copy of each object, including their IDs. It is useful for bulk data operations where multiple objects need to be created… - [Retrieve discounts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/batch/get-discounts.md): Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint is useful for fetching multiple objects at once, allowing you to specify which properties to include in the response. It supports filtering for archived objects. - [Update discounts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/batch/update-discounts.md): Update a batch of CRM objects by specifying their properties. This endpoint allows you to perform bulk updates on objects of a specified type, which can be useful for synchronizing data or applying changes across multiple records efficiently. - [Upsert discounts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/batch/upsert-discounts.md): Create or update a batch of CRM objects by their unique property values. This endpoint allows you to efficiently manage multiple objects in a single request, ensuring that existing objects are updated and new ones are created as needed. - [Delete discounts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/batch/delete-discounts.md): Archive a batch of CRM objects identified by their IDs. This operation moves the specified objects to the archive, effectively removing them from active use but retaining them for potential future restoration. This is useful for managing large sets of data that are no longer needed in active operati… #### Search - [Search for a discount](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/discounts/search/search-discounts.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 specific conditions. The search results include the total number of matching objects and the objects themselves. ### Feedback Submissions - [Survey Responses API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/feedback-submissions/guide.md): Survey response records store information about individual survey responses. The API endpoints allow you to manage this data and sync it between HubSpot and other systems. - [Feedback submission object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/feedback-submissions/object-definition.md): Information about the Feedback submission object, including identifiers, feature support, and default properties. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/feedback-submissions/get-feedback-submission.md): Read an object identified by `{objectId}` in the HubSpot CRM. By default, `{objectId}` refers to the internal object ID, but you can specify any unique property value using the `idProperty` query parameter. Customize the response by selecting specific properties with the `properties` query parameter… - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/feedback-submissions/get-feedback-submissions.md): Read a page of CRM objects of a specified type. Use the `properties` query parameter to control which properties are returned. This endpoint supports pagination and can include associated object IDs if specified. #### Batch - [Read a batch of feedback submissions by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/feedback-submissions/batch/get-feedback-submissions.md): Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint allows you to specify the properties you wish to include in the response. It is useful for obtaining detailed information about multiple objects in a single request, which can be beneficial for data analys… #### Search - [Search for feedback submissions using specified criteria.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/feedback-submissions/search/search-feedback-submissions.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 include in the response. It is useful for retrieving a subset of objects that meet specific conditions. ### Fees - [Fees API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/guide.md): Learn how you can create and manage fees that can be included in invoices and legacy quotes. - [Fee object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/object-definition.md): Information about the Fee object, including identifiers, feature support, and default properties. - [Create a fee](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/create-fee.md): Create a CRM object with the specified properties and receive 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 available. - [Retrieve a fee](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/get-fee.md): Read an object identified by `objectId`. This endpoint allows you to retrieve details of a specific CRM object using its internal ID or any unique property value specified by the `idProperty` query parameter. You can control the response content by specifying desired properties through the `properti… - [Retrieve fees](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/get-fees.md): Retrieve a page of CRM objects of a specified type. Customize the response by selecting specific properties to return using the `properties` query parameter. This endpoint supports pagination and can include associated object IDs if requested. - [Update a fee](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/update-fee.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 a fee](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/delete-fee.md): Move an Object identified by `{objectId}` to the recycling bin. This operation allows you to archive a specific CRM object by its unique identifier, effectively removing it from active use while retaining the option to restore it later if needed. #### Batch - [Create fees](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/batch/create-fees.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, streamlining the process of populating your CRM with new data. Each object must have the necessary properties defined, and the response will include the created obje… - [Retrieve fees](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/batch/get-fees.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, which can help optimize performance when working with large datasets. You can specify whether to include archived objects in the response. - [Update fees](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/batch/update-fees.md): Update a batch of CRM objects in your HubSpot account. This endpoint allows you to modify multiple objects of the specified type in a single request. It is useful for bulk updates where you need to change properties of several objects at once. The request body should include the objects to be update… - [Upsert fees](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/batch/upsert-fees.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 its unique properties. - [Delete fees](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/batch/delete-fees.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, streamlining the process of managing large datasets. #### Search - [Search for fees](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/fees/search/search-fees.md): Perform a search for CRM objects of a specified type using various filters and criteria. This endpoint allows you to retrieve objects based on specific properties and conditions, providing flexibility in querying your CRM data. ### Forecasts - [Forecasts API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/forecasts/guide.md): Learn how to retrieve forecast data from your HubSpot account. #### Forecast types - [Retrieve a forecast type](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/forecasts/forecast-types/get-forecast-type.md): Retrieve a specific forecast type by its ID from the HubSpot account. This endpoint is useful for accessing detailed information about a particular forecast type, which defines the properties used in forecasting calculations. - [Retrieve forecast types](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/forecasts/forecast-types/get-forecast-types.md): Returns all forecast types configured for the portal. Forecast types define which properties are used to calculate forecasts. This endpoint is useful for retrieving the different forecast configurations available in your HubSpot account, allowing you to understand how forecasts are generated based o… #### Search - [Search for forecasts](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/forecasts/search/search-forecasts.md): Search for existing forecasts in your HubSpot account. This endpoint allows you to filter and sort objects based on various criteria, providing a flexible way to retrieve specific data. It is useful for finding objects that match certain properties or conditions. ### Goals - [Goals API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/guide.md): Goals are used to create user-specific quotas for their sales and services teams based on templates provided by HubSpot. The goals endpoints allow you to sync this data between HubSpot and other systems. - [Goal object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/object-definition.md): Information about the Goal object, including identifiers, feature support, and default properties. - [Create a goal target](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/create-goal-target.md): Create a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided. - [Retrieve goal target](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/get-goal-target.md): Read an Object identified by `{goalTargetId}`. `{goalTargetId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve goal targets](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/get-goal-targets.md): Read a page of goal targets. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/update-goal-target-objectId.md): Perform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the… - [Update a goal target](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/update-goal-target.md): Perform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the… - [Delete a goal target](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/delete-goal-target.md): Move an Object identified by `{goalTargetId}` to the recycling bin. #### Batch - [Create goal targets](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/batch/create-goal-targets.md): Create multiple goal targets in a single batch operation. - [Retrieve goal targets](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/batch/get-goal-targets.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update goal targets](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/batch/update-goal-targets.md): Update multiple goal targets in a single batch operation using their internal IDs or unique property values. - [Create or update a batch of goal targets by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/batch/upsert-goal-targets.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 goal targets](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/batch/delete-goal-targets.md): Archive multiple goal targets in a single batch operation using their IDs. #### Search - [Search for goal targets](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/goals/search/search-goal-targets.md): Search for goal targets using specified criteria. ### Leads - [Leads API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/guide.md): Leads are contacts or companies that are potential customers who have shown interest in your products or services. The leads endpoints allow you to manage this data and sync it between HubSpot and other systems. - [Lead object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/object-definition.md): Information about the Lead object, including identifiers, feature support, and default properties. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/create-lead.md): Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/get-lead.md): Read an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/get-leads.md): Read a page of leads. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/update-lead.md): Perform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Pr… - [Archive](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/delete-lead.md): Move an Object identified by `{leadsId}` to the recycling bin. #### Batch - [Create a batch of leads](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/batch/create-leads.md): Create multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets. - [Read a batch of leads by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/batch/get-leads.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of leads by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/batch/update-leads.md): Update multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors. - [Create or update a batch of leads by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/batch/upsert-leads.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 a batch of leads by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/batch/delete-leads.md): Archive multiple leads by their IDs in a single request, moving them to the recycling bin. #### Search - [Search for leads](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/leads/search/search-leads.md): Perform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page. ### Line Items - [Line Items API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/guide.md): In HubSpot, line items represent individual instances of products on a deal, quote, or other object. The line items endpoints allow you to manage and sync this data. - [Line item object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/object-definition.md): Information about the Line item object, including identifiers, feature support, and default properties. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/create-line-item.md): Create a CRM object with the specified properties and return a copy of the object, including its ID. This endpoint allows you to create standard objects in your HubSpot account, and provides documentation and examples for the process. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/get-line-item.md): Read an object identified by `objectId` in your HubSpot account. By default, `objectId` refers to the internal object ID, but you can specify a unique property using the `idProperty` query parameter. Use the `properties` query parameter to control which properties are returned in the response. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/get-line-items.md): Read a page of objects of a specified type in your HubSpot account. You can control the data returned by specifying desired properties through query parameters. This endpoint is useful for retrieving a list of CRM objects, such as contacts or deals, with optional filtering and pagination. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/update-line-item.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](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/delete-line-item.md): Move an Object identified by `{objectId}` to the recycling bin. This operation allows you to archive a specific CRM object, effectively removing it from active use while retaining the option to restore it later if needed. #### Batch - [Create a batch of line items](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/batch/create-line-items.md): Create a batch of CRM objects of a specified type in your HubSpot account. 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 response will include the details of the created objects,… - [Read a batch of line items by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/batch/get-line-items.md): Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint allows you to specify which properties and property histories to return for each object. It supports filtering results to include only archived objects if needed. - [Update a batch of line items by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/batch/update-line-items.md): Update a batch of CRM objects in your HubSpot account. This endpoint allows you to modify multiple objects simultaneously by providing their updated properties. It is useful for bulk updates where changes need to be applied to several records at once. - [Create or update a batch of line items by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/batch/upsert-line-items.md): Create or update a batch of CRM objects by their unique property values. This endpoint allows for efficient management of multiple objects in a single request, ensuring that existing objects are updated and new ones are created as needed. - [Archive a batch of line items by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/batch/delete-line-items.md): Archive a batch of CRM objects by their IDs. This endpoint allows you to move multiple objects of a specified type to the recycling bin in a single request, which can be useful for bulk data management and cleanup operations. #### Search - [Search for line items using specified criteria.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/line-items/search/search-line-items.md): Search for CRM objects of a specified type using various filters and criteria. This endpoint allows you to perform complex searches and retrieve objects that match the specified conditions. It is useful for finding specific records based on property values or other attributes. ### Object Tags - [Object Tags API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/object-tags/guide.md): Create and manage object tag definitions. - [Create tag](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/object-tags/create-object-tag.md): Create a new CRM object tag for a specified object type in your HubSpot account. This endpoint allows you to define properties such as name, color, and filter criteria for the tag. It is useful for categorizing and organizing CRM objects based on custom criteria. - [Retrieve Tag](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/object-tags/get-object-tag.md): Retrieve a specific CRM object tag using its unique identifiers. This endpoint is useful for obtaining details about a particular tag associated with a CRM object type, which can help in managing or analyzing tagged data within your HubSpot account. - [Retrieve tags](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/object-tags/get-object-tags.md): Retrieve CRM object tags for a specified object type in your HubSpot account. This endpoint allows you to access tags associated with a particular object type, which can be useful for categorizing and managing CRM data effectively. - [Update tag (Partial)](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/object-tags/partially-update-object-tag.md): Update an existing CRM object tag in your HubSpot account. This endpoint allows you to modify properties of a specific tag identified by its tagId and objectTypeId. Use this to change tag attributes such as color, description, or associated filters. - [Update tag (Replace)](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/object-tags/update-object-tag.md): Update an existing CRM object tag in your HubSpot account. This operation allows you to modify the properties of a tag identified by its objectTypeId and tagId. Use this endpoint to change tag details such as name, color, and associated filters. - [Delete](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/object-tags/delete-object-tag.md): Delete a specific CRM object tag identified by its object type ID and tag ID. This operation will remove the tag from the system, and it will no longer be available for use or reference. ### Objects - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/create-object.md): Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/get-object.md): Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/get-objects.md): Read a page of objects. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/update-object.md): Perform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object.… - [Archive](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/delete-object.md): Move an Object identified by `{objectId}` to the recycling bin. #### Batch - [Create a batch of objects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/batch/create-objects.md) - [Read a batch of objects by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/batch/get-objects.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of objects by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/batch/update-objects.md) - [Create or update a batch of objects by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/batch/upsert-objects.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 a batch of objects by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/batch/delete-objects.md) #### Search - [Search records](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/objects/search/search-objects.md) ### Partner Clients - [Retrieve a partner client](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-clients/get-partner-client.md): Read an object identified by `objectId`. By default, `objectId` refers to the internal object ID, but it can also refer to any unique property value specified by the `idProperty` query parameter. You can control the data returned by specifying the `properties` query parameter. - [Retrieve partner clients](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-clients/get-partner-clients.md): Retrieve a page of CRM objects of a specified type. You can control the data returned by specifying properties, associations, and whether to include archived records. This endpoint supports pagination to navigate through large sets of data. - [Update properties of a specific partner client.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-clients/update-partner-client-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 a partner client](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-clients/update-partner-client.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… #### Batch - [Retrieve a batch of partner client objects.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-clients/batch/get-partner-clients.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. The response includes the objects' details, and you can specify whether to include archived objects. #### Search - [Search for partner clients](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-clients/search/search-partner-clients.md): Search CRM objects of a specified type using various filters and criteria. This endpoint allows you to perform complex queries to retrieve CRM objects based on specific properties or conditions. It is useful for finding objects that meet certain criteria within your HubSpot account. ### Partner Services - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-services/get-partner-service.md): Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-services/get-partner-services.md): Read a page of CRM objects of a specified type. You can control the data returned by specifying properties to include in the response. This endpoint is useful for retrieving a list of objects with specific details, and it supports pagination for large datasets. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-services/update-partner-service-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](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-services/update-partner-service.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… #### Batch - [Read a batch of partner services by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-services/batch/get-partner-services.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 results. - [Update a batch of partner services by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-services/batch/update-partner-services.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 making bulk updates to CRM data efficiently. The response will include the updated objects, and any errors encountered during the update… #### Search - [Search for partner services using specified criteria.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/partner-services/search/search-partner-services.md): Perform a search on CRM objects of a specified type. This endpoint allows you to filter and retrieve objects based on various criteria defined in the request body. It is useful for finding specific records or sets of records that match your search parameters. ### Price Book Items - [Retrieve a price book item](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/price-book-items/get-price-book-item.md): Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [Retrieve price book items](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/price-book-items/get-price-book-items.md): Retrieve a page of CRM objects of a specified type. You can control the data returned by specifying properties, associations, and whether to include archived records. This endpoint is useful for fetching a list of objects with specific attributes or associations. #### Batch - [Batch retrieve price book items](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/price-book-items/batch/get-price-book-items.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 results. ### Price Books - [CRM API | Price books](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/price-books/guide.md): Retrieve price book and price book item records as CRM objects. - [Retrieve a price book](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/price-books/get-price-book.md): Read an object identified by `{objectId}`. By default, `{objectId}` refers to the internal object ID, but you can specify any unique property value using the `idProperty` query parameter. Use the `properties` query parameter to control which properties are returned in the response. - [Retrieve price books](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/price-books/get-price-books.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 supports pagination through the use of a cursor token. #### Batch - [Batch retrieve price books](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/price-books/batch/get-price-books.md): Retrieve a batch of CRM objects by their internal IDs or unique property values. This endpoint allows you to specify the properties and their history to be included in the response. It is useful for efficiently fetching multiple objects' data in a single request. ### Products - [Products API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/guide.md): In HubSpot, products represent the goods or services you sell. The products endpoints allow you to manage and sync this data. - [Product object definition](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/object-definition.md): Information about the Product object, including identifiers, feature support, and default properties. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/create-product.md): Create a CRM object with the specified properties and return a copy of the object, including its ID. This endpoint allows you to create standard objects in your HubSpot account, providing documentation and examples for guidance. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/get-product.md): Read an object identified by `objectId`. The `objectId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query parameter. You can control the response content by specifying desired properties using the `properties` query parameter. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/get-products.md): Retrieve a page of CRM objects of a specified type. You can control the data returned by specifying certain properties, associations, and whether to include archived records. This endpoint is useful for fetching a list of objects with specific attributes and associations. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/update-product.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](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/delete-product.md): Move an Object identified by `{objectId}` to the recycling bin. This operation allows you to archive a specific CRM object by its unique identifier, effectively removing it from active use while retaining it in the system for potential recovery or auditing purposes. #### Batch - [Create a batch of products](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/batch/create-products.md): Create a batch of CRM objects with the specified properties. This endpoint allows for the creation of multiple objects in a single request, which can be useful for efficiently importing large datasets or synchronizing data from external systems. The response includes the created objects with their I… - [Read a batch of products by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/batch/get-products.md): Read a batch of CRM objects by their internal IDs or unique property values. This endpoint is useful for retrieving multiple objects in a single request, allowing for efficient data fetching. You can specify whether to include archived objects in the results. - [Update a batch of products by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/batch/update-products.md): Update a batch of CRM objects in your HubSpot account. This endpoint allows you to update multiple objects of a specified type by providing their properties in the request body. It's useful for making bulk updates to objects without having to update them individually. - [Create or update a batch of products by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/batch/upsert-products.md): Create or update a batch of CRM objects by unique property values. This endpoint allows for efficient management of multiple objects in a single request, ensuring that each object is either created or updated based on its unique identifiers. - [Archive a batch of products by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/batch/delete-products.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. The operation does not return any content upon success, indicating that the objects have been successfully archived. #### Search - [Search for products using specified criteria.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/products/search/search-products.md): Search for CRM objects of a specified type using various filters and criteria. This endpoint allows you to retrieve a collection of objects based on search parameters defined in the request body. It is useful for finding specific records that match certain conditions within your HubSpot account. ### Projects - [Projects API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/guide.md): Projects help you plan and organize your team's work in one place with structured lists of tasks. Learn how to use the projects endpoints to get project data from your account. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/create-project.md): Create a CRM object with the specified properties and receive a copy of the object, including its ID. This endpoint allows for the creation of standard objects, with documentation and examples provided to assist in the process. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/get-project.md): Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/get-projects.md): Read a page of CRM objects of a specified type. You can control the data returned by specifying the properties you want to include in the response. This endpoint supports pagination and allows you to retrieve associated object IDs and archived records. - [Merge two projects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/merge-projects.md): Merge two CRM objects of the same type in your HubSpot account. This operation combines the properties of the specified objects into a single object, retaining the primary object's ID. Use this endpoint to consolidate duplicate records or unify data under a single object. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/update-project.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](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/delete-project.md): Move an Object identified by `{objectId}` to the recycling bin. This operation allows you to archive a specific CRM object, effectively removing it from active use while retaining it in the system for potential recovery or auditing purposes. #### Batch - [Create a batch of projects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/batch/create-projects.md): Create a batch of CRM objects with specified properties in HubSpot. This endpoint allows you to create multiple objects in a single request, making it efficient for bulk operations. The response includes the created objects along with their IDs. Use this endpoint to streamline the creation of large… - [Read a batch of projects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/batch/get-projects.md): Read a batch of CRM objects by their internal IDs or unique property values. This endpoint allows you to retrieve multiple objects in a single request, which is useful for efficiently gathering data on a set of objects. You can specify whether to include archived objects in the results. - [Update a batch of projects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/batch/update-projects.md): Update a batch of CRM objects in your HubSpot account. This endpoint allows you to modify multiple objects at once by providing their details in the request body. It is useful for bulk updates where you need to change properties for several objects simultaneously. The response will include the statu… - [Create or update a batch of projects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/batch/upsert-projects.md): Create or update a batch of CRM objects by their unique property values. This endpoint allows for efficient management of multiple objects in a single request, ensuring that each object is either created or updated based on the provided unique identifiers. - [Archive a batch of projects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/batch/delete-projects.md): Archive a batch of CRM objects by their IDs. This operation moves the specified objects to the recycling bin, effectively archiving them. Use this endpoint to manage large sets of objects that need to be archived simultaneously. #### Search - [Search for projects](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/projects/search/search-projects.md): Search for CRM objects of a specified type using various filters and criteria. This endpoint allows you to perform complex queries to find objects that match specific conditions. It returns a collection of objects that meet the search criteria, along with the total count of results. ### Quotes - [Quotes API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/guide.md): Use the quotes API to create and manage HubSpot quotes for sharing pricing with buyers, collecting signatures, and more. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/create-quote.md): Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/get-quote.md): Read an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/get-quotes.md): Read a page of quotes. Control what is returned via the `properties` query param. - [Quote rules syntax](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/quote-rules-syntax.md): Reference information for writing quote validation rules using the quote rules DSL. - [Update a quote](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/update-quote-objectId.md): Perform a partial update of an Object identified by `{quoteId}`or optionally a unique property value as specified by the `idProperty` query param. `{quoteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Pr… - [Partially update a quote](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/update-quote.md): Perform a partial update of an Object identified by `{quoteId}`or optionally a unique property value as specified by the `idProperty` query param. `{quoteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Pr… - [Archive](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/delete-quote.md): Move an Object identified by `{quoteId}` to the recycling bin. #### Batch - [Create a batch of quotes](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/batch/create-quotes.md): Create multiple quotes in a single request by providing a batch of quote objects, each with its own properties and optional associations. - [Read a batch of quotes by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/batch/get-quotes.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of quotes by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/batch/update-quotes.md): Update multiple quotes using their internal IDs or unique property values. This endpoint allows batch processing of quote updates, ensuring efficient management of multiple records in a single request. - [Create or update a batch of quotes by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/batch/upsert-quotes.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 a batch of quotes by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/batch/delete-quotes.md): Archive multiple quotes by their IDs in a single request, effectively moving them to the recycling bin. #### Search - [Search for quotes using specified criteria.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/quotes/search/search-quotes.md): Execute a search for quotes based on the criteria defined in the request body, such as filters, properties, and sorting options. This endpoint allows for detailed querying of quote records to retrieve specific data sets. ### Schemas - [Schemas API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/schemas/guide.md): Use the schemas API to define new custom objects, and retrieve or edit custom object schema details. - [Create a new custom object schema.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/schemas/create-schema.md): Create a new custom object schema by defining its properties and associations. - [Retrieve the schema of a specified custom object.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/schemas/get-schema.md): Retrieve details of a custom object schema, including its properties and associations, using the object type ID or fully qualified name. - [Retrieve all custom object schemas.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/schemas/get-schemas.md): Retrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata. - [Update the schema of a specified custom object.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/schemas/update-schema.md): Update attributes of a custom object schema, such as properties and labels, using the object type ID or fully qualified name. - [Delete the schema of a specified custom object.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/schemas/delete-schema.md): Remove a custom object schema from the account using its object type ID or fully qualified name. #### Batch - [Retrieve multiple custom object schemas in a batch request.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/schemas/batch/get-schemas.md): Retrieve details of multiple custom object schemas by providing a batch request with specified inputs. This operation allows you to fetch schema information, including properties and associations, for multiple custom objects in a single API call. ### Taxes - [Taxes API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/guide.md): Learn how to create and associate a tax as part of the pricing details of a quote. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/create-tax.md): Create a CRM object with the specified properties and receive a copy of the object, including its ID. This endpoint is useful for adding new objects to your CRM system, allowing you to define the properties of the object upon creation. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/get-tax.md): Read an object identified by `objectId` in the specified `objectType`. By default, `objectId` refers to the internal object ID, but it can also refer to any unique property value as specified by the `idProperty` query parameter. You can control the response content using the `properties` query param… - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/get-taxes.md): Read a page of CRM objects of a specified type. You can control the data returned by using the `properties` query parameter to specify which object properties to include. This endpoint supports pagination and allows you to retrieve associated IDs for specified object types. - [Update](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/update-tax.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](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/delete-tax.md): Move an Object identified by `{objectId}` to the recycling bin. This operation allows you to archive a specific CRM object, making it no longer active but still retrievable from the recycling bin if needed. #### Batch - [Create a batch of taxes](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/batch/create-taxes.md): Create a batch of CRM objects with the specified properties. This endpoint allows you to efficiently create multiple objects in a single request, returning a copy of each created object including their IDs. It is useful for bulk operations where multiple objects need to be created simultaneously. - [Read a batch of taxes by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/batch/get-taxes.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, streamlining data retrieval processes. You can specify whether to include archived objects in the results. - [Update a batch of taxes by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/batch/update-taxes.md): Update a batch of CRM objects in your HubSpot account. This endpoint allows you to modify multiple objects at once by providing their details in the request body. It is useful for bulk updates where you need to change properties of several objects simultaneously. - [Create or update a batch of taxes by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/batch/upsert-taxes.md): Create or update a batch of CRM objects by unique property values in your HubSpot account. This endpoint allows you to efficiently manage large sets of objects by either creating new entries or updating existing ones based on unique identifiers. - [Archive a batch of taxes by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/batch/delete-taxes.md): Archive a batch of CRM objects identified by their IDs. This endpoint is useful for moving multiple objects to the recycling bin in a single request, streamlining the process of managing large datasets. #### Search - [Search for taxes using specified criteria.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/taxes/search/search-taxes.md): Perform a search on CRM objects of a specified type. This endpoint allows you to filter and sort objects based on various criteria, and retrieve specific properties of the objects. It is useful for finding objects that match certain conditions or for retrieving a subset of data for analysis. ### Users - [Users API](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/guide.md): A user object stores information such as a user's working hours, timezone, additional phone number, and job title. The user endpoints allow you to manage this data and sync it between HubSpot and other systems. - [Create](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/create-user.md): Create a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided. - [Read](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/get-user.md): Read an Object identified by `{userId}`. `{userId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. - [List](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/get-users.md): Read a page of users. Control what is returned via the `properties` query param. - [Update user](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/update-user.md): Perform a partial update of an Object identified by `{userId}`or optionally a unique property value as specified by the `idProperty` query param. `{userId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Prov… - [Archive](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/delete-user.md): Move an Object identified by `{userId}` to the recycling bin. #### Batch - [Create a batch of users](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/batch/create-users.md): Create multiple users in a single request by providing a batch of user properties and associations. This endpoint returns the created users along with their IDs. - [Read a batch of users by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/batch/get-users.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of users by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/batch/update-users.md): Update multiple user records in a single request by specifying their internal IDs or unique property values. This operation allows for batch processing of user data, ensuring efficient updates across multiple user profiles. - [Create or update a batch of users by unique property values](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/batch/upsert-users.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 a batch of users by ID](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/batch/delete-users.md): Archive multiple users by their IDs in a single request. This operation moves the specified users to the recycling bin, effectively deactivating them from active use. #### Search - [Search for users based on specified criteria.](https://developers.hubspot.com/docs/api-reference/latest/crm/objects/users/search/search-users.md): Execute a search for users using defined filters, properties, and sorting options. The request must include a search query and can return up to 200 results per request. ## OpenAPI Specs - [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)