# HubSpot docs: APIs Legacy CRM Objects ## Objects - [APIs / Legacy / CRM / Objects / Contacts (41 pages)](https://developers.hubspot.com/docs/_llms/apis/legacy/crm/objects/contacts.md): Documentation for APIs / Legacy / CRM / Objects / Contacts. - [APIs / Legacy / CRM / Objects / Line Items (22 pages)](https://developers.hubspot.com/docs/_llms/apis/legacy/crm/objects/line-items.md): Documentation for APIs / Legacy / CRM / Objects / Line Items. - [APIs / Legacy / CRM / Objects / Products (22 pages)](https://developers.hubspot.com/docs/_llms/apis/legacy/crm/objects/products.md): Documentation for APIs / Legacy / CRM / Objects / Products. - [APIs / Legacy / CRM / Objects / Tickets (23 pages)](https://developers.hubspot.com/docs/_llms/apis/legacy/crm/objects/tickets.md): Documentation for APIs / Legacy / CRM / Objects / Tickets. ### Appointments - [Create an appointment](https://developers.hubspot.com/docs/api-reference/legacy/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 an appointment](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/crm/objects/appointments/get-appointments.md): Read a page of appointments. Control what is returned via the `properties` query param. - [Update an appointment](https://developers.hubspot.com/docs/api-reference/legacy/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 an appointment](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/appointments/delete-appointment.md): Move an Object identified by `{appointmentId}` to the recycling bin. #### Batch - [Create appointments](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/appointments/batch/create-appointments.md): Create multiple appointments in a single request. - [Retrieve appointments](https://developers.hubspot.com/docs/api-reference/legacy/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 appointments](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/appointments/batch/update-appointments.md): Update multiple appointments using their internal IDs or unique property values. - [Upsert appointments](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Delete appointments](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/appointments/batch/delete-appointments.md): Archive multiple appointments using their IDs. #### Search - [Search for appointments](https://developers.hubspot.com/docs/api-reference/legacy/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 - [CRM API | Carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/guide.md): Create and manage ecommerce cart data. - [Create a cart](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/create-cart.md): Create a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided. - [Retrieve a cart](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/get-cart.md): Read an Object identified by `{cartId}`. `{cartId}` 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 carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/get-carts.md): Retrieve all carts. You can control what is returned via the `properties` query parameter. - [Update a cart](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/update-cart.md): Perform a partial update of an Object identified by `{cartId}`or optionally a unique property value as specified by the `idProperty` query param. `{cartId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Prov… - [Delete a cart](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/delete-cart.md): Move an Object identified by `{cartId}` to the recycling bin. #### Batch - [Create a batch of carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/batch/create-carts.md): Create a batch of carts with specified properties and associations. - [Retrieve a batch of carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/batch/get-carts.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/batch/update-carts.md): Update a batch of carts using their internal IDs or unique property values. - [Upsert a batch of carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/batch/upsert-carts.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 carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/batch/delete-carts.md): Archive a batch of carts identified by their IDs. #### Search - [Search for carts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/carts/search/search-carts.md): Search for carts based on the specified search criteria, such as filters and properties, and retrieve the matching results. ### Commerce Payments - [Payments API](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/guide.md): Retrieve information about payments. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/create-commerce-payment.md): Create a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/get-commerce-payment.md): Read an Object identified by `{commercePaymentId}`. `{commercePaymentId}` 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/legacy/crm/objects/commerce-payments/get-commerce-payments.md): Read a page of commerce payments. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/update-commerce-payment.md): Perform a partial update of an Object identified by `{commercePaymentId}`or optionally a unique property value as specified by the `idProperty` query param. `{commercePaymentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are uniqu… - [Archive](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/delete-commerce-payment.md): Move an Object identified by `{commercePaymentId}` to the recycling bin. #### Batch - [Create a batch of commerce payments](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/batch/create-commerce-payments.md): Create multiple commerce payment records in a single request, returning the details of each created payment, including their unique IDs. - [Read a batch of commerce payments by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/batch/get-commerce-payments.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of commerce payments by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/batch/update-commerce-payments.md): Update multiple commerce payment records using their internal IDs or unique property values. This operation allows you to modify existing payment records in bulk by providing a list of records with their respective IDs and updated property values. - [Create or update a batch of commerce payments by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/batch/upsert-commerce-payments.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 commerce payments by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/batch/delete-commerce-payments.md): Archive a batch of commerce payments by their IDs. This operation moves the specified payments to the archive, making them inactive in the system. #### Search - [Search for commerce payments using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-payments/search/search-commerce-payments.md): Execute a search for commerce payments based on the provided filter groups, properties, and sorting options. This endpoint allows for complex queries to retrieve specific payment records from the CRM. ### Commerce Subscriptions - [Subscriptions API](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/commerce-subscriptions/guide.md): Retrieve information about subscriptions. - [Create a new subscription object.](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/crm/objects/commerce-subscriptions/get-commerce-subscription.md): Retrieve a specific subscription by its ID, including its properties and associations. - [Retrieve a list of subscription objects.](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/crm/objects/commerce-subscriptions/delete-commerce-subscription.md): Delete a specific subscription by its ID. #### Batch - [Batch create subscription objects.](https://developers.hubspot.com/docs/api-reference/legacy/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 a batch of subscription objects by IDs.](https://developers.hubspot.com/docs/api-reference/legacy/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 multiple subscriptions in a batch.](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Perform a batch upsert operation on subscription objects.](https://developers.hubspot.com/docs/api-reference/legacy/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 subscription objects in a single request.](https://developers.hubspot.com/docs/api-reference/legacy/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 CRM commerce subscriptions using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/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. ### Communications - [Engagements | Communications](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/guide.md): Learn how to use the communication APIs, which allow you to log WhatsApp, LinkedIn, and SMS messages to the CRM record timeline. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/create-communication.md): Create a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/get-communication.md): Read an Object identified by `{communicationId}`. `{communicationId}` 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/legacy/crm/objects/communications/get-communications.md): Read a page of communications. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/update-communication.md): Perform a partial update of an Object identified by `{communicationId}`or optionally a unique property value as specified by the `idProperty` query param. `{communicationId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique fo… - [Archive](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/delete-communication.md): Move an Object identified by `{communicationId}` to the recycling bin. #### Batch - [Create a batch of communications](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/batch/create-communications.md): Create a batch of messages. The `inputs` array can contain a `properties` object to define property values for each message, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records. - [Read a batch of communications by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/batch/get-communications.md): Retrieve a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). - [Update a batch of communications by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/batch/update-communications.md): Update a batch of messages by ID (`communicationId`) 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. - [Create or update a batch of communications by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/batch/upsert-communications.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 communications by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/batch/delete-communications.md): Delete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record). #### Search - [Search for messages](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/communications/search/search-communications.md): Search for messages 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). ### Companies - [CRM API | Companies](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Create a company](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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). #### v2 - [Get a company by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/get-companies-v2-companies-company-id.md): Retrieve data about a company in HubSpot, specified by its ID. This endpoint can be helpful for syncing changes made to a particular company in HubSpot to the corresponding record in an Account-Based Marketing (ABM) system, or to look up specific attributes of a company. - [Get contacts at a company](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/get-companies-v2-companies-companyId-contacts.md): Returns all of the contacts who have a specified ID in the `associatedCompanyId` contact property. Returns 20 contacts by default. You can get up to 100 contacts per request using the `count` parameter. You can use the `vidoffset` field returned in the results with the `vidOffset` parameter to get t… - [Get all companies](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/get-companies-v2-companies-paged.md): Retrieve all companies in a HubSpot account. This endpoint can be useful when needing to sync company data from HubSpot. For example, if you install an app that integrates HubSpot with an Enterprise Resource Planning (ERP) app, that app may want to get all the company records stored in the CRM. It c… - [Get recently created companies](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/get-companies-v2-companies-recent-create-d.md): Returns a list of all companies sorted by the date the companies were most recently modified or created. - [Get recently modified and created companies](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/get-companies-v2-companies-recent-modified.md): Returns a list of all companies sorted by the date the companies were most recently modified or created. This is particularly useful for ongoing syncs with HubSpot in which changes to companies must be captured in another system. Note: This endpoint will only return records modified or created in th… - [Create a company](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/post-companies-v2-companies.md): Create a company record for a given account. Properties are specified in the request body via the `properties` field. - [Search for companies by domain](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/post-companies-v2-domains-domain-companies.md): Search for companies by domain name (e.g., `hubspot.com`). - [Update a company](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/put-companies-v2-companies-company-id.md): Update an existing company with new property values. These properties and values must be specified by JSON in the request body. - [Delete a company](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v2/delete-companies-v2-companies-company-id.md): Delete an existing company specified by ID. Returns JSON indicating whether or not the specified company was actually deleted. Since companies play a central role in the CRM, it's recommended to only delete companies that your application has created. #### v1 - [Update a group of companies](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/companies/v1/post-companies-v1-batch-async-update.md): Update a group of existing company records by their companyId. This endpoint takes a list of objectIds and that correspond to the companyId of the company you want to update, and a list of properties to update for that company. Note: - This endpoint can only be used to update existing company record… ### Contracts - [Read](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/crm/objects/contracts/get-contracts.md): Read a page of contracts. Control what is returned via the `properties` query param. ### Courses - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/create-course.md): Create a course with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard courses is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/get-course.md): Read an Object identified by `{courseId}`. `{courseId}` 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/legacy/crm/objects/courses/get-courses.md): Read a page of courses. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/update-course.md): Perform a partial update of an Object identified by `{courseId}`or optionally a unique property value as specified by the `idProperty` query param. `{courseId}` 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/legacy/crm/objects/courses/delete-course.md): Move an Object identified by `{courseId}` to the recycling bin. #### Batch - [Create a batch of courses](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/batch/create-courses.md): Create a batch of objects - [Read a batch of courses by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/batch/get-courses.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of courses by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/batch/update-courses.md): Update a batch of objects - [Create or update a batch of courses by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/batch/upsert-courses.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 courses by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/batch/delete-courses.md): Archive a batch of objects #### Search - [Search for objects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/courses/search/search-courses.md): Fetch objects using a search query ### Custom Objects - [Custom object records API guide](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/custom-objects/guide.md): HubSpot custom objects allow organizations to represent and organize data based on unique business requirements. Create and update custom object records with the custom objects API. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/custom-objects/create-custom-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/legacy/crm/objects/custom-objects/get-custom-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/legacy/crm/objects/custom-objects/get-custom-objects.md): Read a page of objects. Control what is returned via the `properties` query param. - [Merge two objects with same type](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/custom-objects/merge-custom-objects.md): Merge two CRM objects of the same type by specifying one as the primary object and the other as the object to be merged into it. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/custom-objects/update-custom-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/legacy/crm/objects/custom-objects/delete-custom-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/legacy/crm/objects/custom-objects/batch/create-custom-objects.md): Create multiple CRM objects in a single request by specifying the object type and providing the necessary properties and associations for each object. - [Read a batch of objects by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/custom-objects/batch/get-custom-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/legacy/crm/objects/custom-objects/batch/update-custom-objects.md): Update a batch of CRM objects by their internal IDs or unique property values, allowing for efficient modifications of multiple records in a single request. - [Create or update a batch of objects by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/custom-objects/batch/upsert-custom-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/legacy/crm/objects/custom-objects/batch/delete-custom-objects.md): Archive a batch of objects by their unique IDs. This operation moves the specified objects to the recycling bin, effectively marking them as archived. #### Search - [Search for CRM objects of a specified type.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/custom-objects/search/search-custom-objects.md): Execute a search query to find CRM objects of a given type, using specified filters and properties. The search can be customized with filters, sorting, and pagination options. ### Deal Splits - [CRM API | Deal splits](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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 - [CRM API | Deals](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/crm/objects/deals/merge-deals.md): Combine two deals of the same type into a single deal. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/crm/objects/deals/batch/delete-deals.md): Archive multiple deals using their IDs. #### Search - [Search for deals using various filters and criteria to retrieve specific records.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/search/search-deals.md): Search for deals using specified criteria and filters. #### v1 - [Get all deals](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/get-deals-v1-deal-paged.md): Get all deals in an account sorted by their created date, with the most recently created deals first. Use the offset parameter returned in a response to get the next set of deals. Note: This endpoint will only return records created in the last 30 days, or the 10k most recently created records. If y… - [Get recently created deals](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/get-deals-v1-deal-recent-create-d.md): Get recently created deals in an account sorted by their created date, with the most recently created deals first. Use the offset parameter returned in a response to get the next set of deals. Note: This endpoint will only return records created in the last 30 days, or the 10k most recently created… - [Get recently modified deals](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/get-deals-v1-deal-recent-modified.md): Get recently modified deals in an account sorted by their last modified date, starting with the most recently modified deals. Use the offset parameter described below to page backwards through the deals. Note: This endpoint will only return records modified in the last 30 days, or the 10k most recen… - [Get a deal](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/get-deals-v1-dealdeal-id.md): The _get a deal_ endpoint retrieves deal information from a HubSpot account, including any associated contact, company, and ticket information. It allows data syncing from HubSpot to external CRMs, accounting systems, forecasting software, and reporting applications. What's a use case for this endpo… - [Create a deal](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/post-deals-v1-deal.md): The _create a deal_ endpoint is used to create and track deals in HubSpot. It also allows you to connect HubSpot with an external CRM or other sales management software. What's a use case for this endpoint? Your company uses HubSpot along with an external CRM and website hosting platform. Your sales… - [Update multiple deals](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/put-deals-v1-batch-async-update.md): Update a group of existing deal records by their dealId. This endpoint takes a list of objectIds that correspond to the dealId of the deal you want to update, and a list of properties to update for each deal. Note: - This endpoint can only be used to update existing deal records based on their dealI… - [Update a deal](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/put-deals-v1-dealdeal-id.md): The _update a deal_ endpoint updates an existing deal in HubSpot using the dealId and JSON-specified properties in the request body. What's a use case for this endpoint? You want to update a deal with a tracking number. To do this, you need to integrate HubSpot with your shipping software, which sto… - [Delete a deal](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/deals/v1/delete-deals-v1-dealdeal-id.md): Deletes the existing deal specified by dealId. Use case for this endpoint: You might need to delete deals that were created in error or are no longer valid. ### Discounts - [CRM API | Discounts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/guide.md): Learn how to create and associate a discount as part of the pricing details of a quote. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/create-discount.md): Create a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/get-discount.md): Read an Object identified by `{discountId}`. `{discountId}` 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/legacy/crm/objects/discounts/get-discounts.md): Read a page of discounts. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/update-discount.md): Perform a partial update of an Object identified by `{discountId}`or optionally a unique property value as specified by the `idProperty` query param. `{discountId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the obje… - [Archive](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/delete-discount.md): Move an Object identified by `{discountId}` to the recycling bin. #### Batch - [Create a batch of discounts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/batch/create-discounts.md): Create multiple discounts in a single request by providing the necessary properties and associations for each discount. This operation returns a list of the created discounts, including their unique identifiers. - [Read a batch of discounts by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/batch/get-discounts.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of discounts by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/batch/update-discounts.md): Update multiple discounts by specifying either their internal IDs or unique property values. This operation allows you to modify the properties of several discount records in a single request. - [Create or update a batch of discounts by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/batch/upsert-discounts.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 discounts by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/batch/delete-discounts.md): Archive multiple discounts by their IDs in a single request. This operation moves the specified discounts to the recycling bin, effectively removing them from active use. #### Search - [Search for a discount](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/discounts/search/search-discounts.md): Search for discounts 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). ### Feedback Submissions - [Survey responses](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/feedback-submissions/get-feedback-submission.md): Read an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` 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/legacy/crm/objects/feedback-submissions/get-feedback-submissions.md): Read a page of feedback submissions. Control what is returned via the `properties` query param. #### Batch - [Read a batch of feedback submissions by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/feedback-submissions/batch/get-feedback-submissions.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. #### Search - [Search for feedback submissions using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/feedback-submissions/search/search-feedback-submissions.md): Execute a search to retrieve feedback submissions based on defined filters, properties, and sorting options. ### Fees - [CRM API | Fees](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/guide.md): Learn how you can create and manage fees that can be included in invoices and legacy quotes. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/create-fee.md): Create a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/get-fee.md): Read an Object identified by `{feeId}`. `{feeId}` 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/legacy/crm/objects/fees/get-fees.md): Read a page of fees. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/update-fee.md): Perform a partial update of an Object identified by `{feeId}`or optionally a unique property value as specified by the `idProperty` query param. `{feeId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provid… - [Archive](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/delete-fee.md): Move an Object identified by `{feeId}` to the recycling bin. #### Batch - [Create a batch of fees](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/batch/create-fees.md): Create multiple fees in a single request by providing a batch of fee objects with their properties and associations. This operation returns a list of the created fee objects, including their unique identifiers. - [Read a batch of fees by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/batch/get-fees.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of fees by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/batch/update-fees.md): Update multiple fee records in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of several fees simultaneously, streamlining the process of managing fee data in bulk. - [Create or update a batch of fees by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/batch/upsert-fees.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 fees by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/batch/delete-fees.md): Archive multiple fees by their IDs, effectively moving them to the recycling bin. #### Search - [Search for fees using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/fees/search/search-fees.md): Perform a search for fees based on various filters and criteria defined in the request body. The search can include specific properties, sorting options, and pagination details to refine the results. ### Forecasts - [Forecasts API](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/forecasts/guide.md): Learn how to retrieve forecast data from your HubSpot account. - [Retrieve a forecast](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/forecasts/get-forecast.md): Retrieve a single forecast. - [Retrieve all forecasts](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/forecasts/get-forecasts.md): Retrieve all forecasts. #### Forecast types - [Retrieve forecast types](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/forecasts/forecast-types/get-forecast-type.md): Retrieve a specific forecast type by its ID. This endpoint allows you to access detailed information about a particular forecast type configured in your HubSpot portal. It is useful for understanding how forecasts are calculated based on specific properties. - [Retrieve forecast types](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/forecasts/forecast-types/get-forecast-types.md): Retrieve all forecast types configured for your portal. Forecast types define which properties are used to calculate forecasts, helping you understand and manage your sales projections effectively. ### Goals - [CRM API | Goals](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/goals/create-goal.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. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Get a page of goal targets](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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 by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/goals/delete-goal-target.md): Move an Object identified by `{goalTargetId}` to the recycling bin. #### Batch - [Create a batch of goal targets](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/goals/batch/create-goal-targets.md): Create multiple goal targets in a single batch operation. - [Read a batch of goal targets by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/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 a batch of goal targets by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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. - [Archive a batch of goal targets by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/goals/batch/delete-goal-targets.md): Archive multiple goal targets in a single batch operation using their IDs. #### Search - [Perform a search for goal targets based on various filters and criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/goals/search/search-goal-targets.md): Search for goal targets using specified criteria. ### Invoices - [Invoices](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/guide.md): Use the invoices API to create, manage, retrieve, and delete the invoices used for billing your customers. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/create-invoice.md): Create a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/get-invoice.md): Read an Object identified by `{invoiceId}`. `{invoiceId}` 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/legacy/crm/objects/invoices/get-invoices.md): Read a page of invoices. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/update-invoice.md): Perform a partial update of an Object identified by `{invoiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{invoiceId}` 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/legacy/crm/objects/invoices/delete-invoice.md): Move an Object identified by `{invoiceId}` to the recycling bin. #### Batch - [Create a batch of invoices](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/batch/create-invoices.md): Create multiple invoices at once by providing a batch of invoice data, and receive a response with details of the created invoices, including their IDs. - [Read a batch of invoices by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/batch/get-invoices.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of invoices by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/batch/update-invoices.md): Update multiple invoices in a single request using either their internal IDs or unique property values. This endpoint allows for efficient batch processing of invoice updates, ensuring that changes are applied consistently across multiple records. - [Create or update a batch of invoices by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/batch/upsert-invoices.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 invoices by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/batch/delete-invoices.md): Archive multiple invoices by their IDs in a single request. This operation moves the specified invoices to the archive, making them inactive but retrievable for future reference. #### Search - [Search for invoices using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/invoices/search/search-invoices.md): Execute a search for invoices based on filter criteria, sorting options, and properties to include in the response. This endpoint supports pagination and allows for complex queries using multiple filter groups. ### Leads - [CRM API | Leads](https://developers.hubspot.com/docs/api-reference/legacy/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. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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 using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/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. ### Listings - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/create-listing.md): Create a listing with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard listings is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/get-listing.md): Read an Object identified by `{listingId}`. `{listingId}` 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/legacy/crm/objects/listings/get-listings.md): Read a page of listings. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/update-listing.md): Perform a partial update of an Object identified by `{listingId}`or optionally a unique property value as specified by the `idProperty` query param. `{listingId}` 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/legacy/crm/objects/listings/delete-listing.md): Move an Object identified by `{listingId}` to the recycling bin. #### Batch - [Create a batch of listings](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/batch/create-listings.md): Create multiple listings in a single request. - [Read a batch of listings by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/batch/get-listings.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of listings by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/batch/update-listings.md): Update multiple listings using their internal IDs or unique property values. - [Create or update a batch of listings by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/batch/upsert-listings.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 listings by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/batch/delete-listings.md): Archive multiple listings by their IDs. #### Search - [Search for listings using various criteria and filters.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/listings/search/search-listings.md): Execute a search query to find listings based on specified filters and properties. ### Object Library - [Object library](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/object-library/guide.md): Learn how to check whether or not objects in the object library are activated for use in a HubSpot account. - [Is object type is enabled](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/object-library/get-object-library-objectTypeId.md) - [Fetch object type enablement status](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/object-library/get-object-library.md) ### Objects - [Create](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/crm/objects/objects/batch/delete-objects.md) #### Search - [Search records](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/objects/search/search-objects.md) ### Orders - [CRM API | Orders](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/guide.md): Create and manage ecommerce order data. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/create-order.md): Create a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/get-order.md): Read an Object identified by `{orderId}`. `{orderId}` 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/legacy/crm/objects/orders/get-orders.md): Read a page of orders. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/update-order.md): Perform a partial update of an Object identified by `{orderId}`or optionally a unique property value as specified by the `idProperty` query param. `{orderId}` 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/legacy/crm/objects/orders/delete-order.md): Move an Object identified by `{orderId}` to the recycling bin. #### Batch - [Create a batch of orders](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/batch/create-orders.md): Create a batch of orders in the system. - [Read a batch of orders by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/batch/get-orders.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of orders by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/batch/update-orders.md): Update a batch of orders using their internal IDs or unique property values. - [Create or update a batch of orders by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/batch/upsert-orders.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 orders by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/batch/delete-orders.md): Archive a batch of orders identified by their IDs. #### Search - [Search for orders in the CRM using various filters and sorting options to retrieve specific order data.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/orders/search/search-orders.md): Execute a search for orders using specified criteria and return matching results. ### Partner Clients - [Retrieve details of a specific partner client.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-clients/get-partner-client.md): Retrieve detailed information about a specific partner client, including selected properties and associations. This endpoint is useful for accessing comprehensive client data for analysis or integration purposes. - [Retrieve a list of partner clients.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-clients/get-partner-clients.md): Retrieve a list of partner clients with optional filtering by deleted status, associations, and specific properties. The response can be paginated using the 'after' parameter. - [Update properties of a specific partner client.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-clients/update-partner-client.md): Update the specified properties of an existing partner client. #### Batch - [Retrieve a batch of partner client objects.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-clients/batch/get-partner-clients.md): Retrieve multiple partner client objects in a single request by specifying their IDs. This endpoint is useful for efficiently accessing data for multiple clients at once, particularly when integrating with third-party systems. - [Update multiple partner client records in a single request.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-clients/batch/update-partner-clients.md): This endpoint allows you to update several partner client records at once by providing a batch of CRM object records with their respective IDs and properties. It is useful for synchronizing data across systems or making bulk updates efficiently. #### Search - [Search for partner clients using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-clients/search/search-partner-clients.md): Execute a search for partner clients based on defined filters, properties, and sorting options. This endpoint allows you to retrieve partner client data that matches the search criteria, facilitating integration and data synchronization with third-party systems. ### Partner Services - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-services/get-partner-service.md): Read an Object identified by `{partnerServiceId}`. `{partnerServiceId}` 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/legacy/crm/objects/partner-services/get-partner-services.md): Read a page of partner services. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-services/update-partner-service.md): Perform a partial update of an Object identified by `{partnerServiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{partnerServiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique… #### Batch - [Read a batch of partner services by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-services/batch/get-partner-services.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of partner services by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-services/batch/update-partner-services.md): Update multiple partner services using their internal IDs or unique property values. This operation allows for batch processing of updates, ensuring efficient synchronization of service data between HubSpot and other systems. #### Search - [Search for partner services using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/partner-services/search/search-partner-services.md): Execute a search query to find partner services based on defined filters, properties, and sorting options. This endpoint allows you to retrieve a collection of partner services that match the specified search criteria. ### Projects - [Projects API](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/crm/objects/projects/create-project.md): Create a project with the given properties and return a copy of the object, including the ID. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/get-project.md): Read an Object identified by `{projectId}`. `{projectId}` 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/legacy/crm/objects/projects/get-projects.md): Read a page of projects. Control what is returned via the `properties` query param. - [Merge two projects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/merge-projects.md): Merge two project records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records). - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/update-project.md): Perform a partial update of an Object identified by `{projectId}`or optionally a unique property value as specified by the `idProperty` query param. `{projectId}` 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/legacy/crm/objects/projects/delete-project.md): Move an Object identified by `{projectId}` to the recycling bin. #### Batch - [Create a batch of projects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/batch/create-projects.md): Create multiple projects in a single request. - [Read a batch of projects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/batch/get-projects.md): Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property. - [Update a batch of projects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/batch/update-projects.md): Update multiple projects using their internal IDs or unique property values. - [Create or update a batch of projects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/batch/upsert-projects.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 projects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/batch/delete-projects.md): Archive multiple projects using their IDs. #### Search - [Search for projects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/projects/search/search-projects.md): Search for projects 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). ### Quotes - [Legacy quotes](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/quotes/guide.md): The legacy quotes API endpoints allow you to create and manage HubSpot quotes and sync quote data to other systems. - [Create](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/crm/objects/quotes/get-quotes.md): Read a page of quotes. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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 - [Create a new custom object schema.](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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. ### Services - [Create](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/create-service.md): Create a service with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard services is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/get-service.md): Read an Object identified by `{serviceId}`. `{serviceId}` 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/legacy/crm/objects/services/get-services.md): Read a page of services. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/update-service.md): Perform a partial update of an Object identified by `{serviceId}`or optionally a unique property value as specified by the `idProperty` query param. `{serviceId}` 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/legacy/crm/objects/services/delete-service.md): Move an Object identified by `{serviceId}` to the recycling bin. #### Batch - [Create a batch of services](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/batch/create-services.md): Create a batch of objects - [Read a batch of services by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/batch/get-services.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of services by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/batch/update-services.md): Update a batch of objects - [Create or update a batch of services by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/batch/upsert-services.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 services by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/batch/delete-services.md): Archive a batch of objects #### Search - [Search across objects](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/services/search/search-services.md): Fetch objects via a search query ### Taxes - [CRM API | Taxes](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/crm/objects/taxes/create-tax.md): Create a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided. - [Read](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/get-tax.md): Read an Object identified by `{taxId}`. `{taxId}` 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/legacy/crm/objects/taxes/get-taxes.md): Read a page of taxes. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/update-tax.md): Perform a partial update of an Object identified by `{taxId}`or optionally a unique property value as specified by the `idProperty` query param. `{taxId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provid… - [Archive](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/delete-tax.md): Move an Object identified by `{taxId}` to the recycling bin. #### Batch - [Create a batch of taxes](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/batch/create-taxes.md): Create multiple tax records in a single request, each with specified properties and optional associations, and receive a response with details of the created objects. - [Read a batch of taxes by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/batch/get-taxes.md): Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. - [Update a batch of taxes by internal ID, or unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/batch/update-taxes.md): Update multiple tax records using their internal IDs or unique property values. This operation allows for batch processing of updates to tax objects, ensuring efficient management of tax data in bulk. - [Create or update a batch of taxes by unique property values](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/batch/upsert-taxes.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 taxes by ID](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/batch/delete-taxes.md): Archive multiple taxes by their IDs in a single request. #### Search - [Search for taxes using specified criteria.](https://developers.hubspot.com/docs/api-reference/legacy/crm/objects/taxes/search/search-taxes.md): Execute a search for tax objects based on defined filters, sorting options, and properties to be included in the response. This allows for customized retrieval of tax data according to specific search parameters. ### Users - [Account | Users API](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/crm/objects/users/get-users.md): Read a page of users. Control what is returned via the `properties` query param. - [Update](https://developers.hubspot.com/docs/api-reference/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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/legacy/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-v3](/docs/specs/legacy/v3/crm-appointments-v3.json) - [crm-carts-v3](/docs/specs/legacy/v3/crm-carts-v3.json) - [crm-commerce-payments-v3](/docs/specs/legacy/v3/crm-commerce-payments-v3.json) - [crm-commerce-subscriptions-v3](/docs/specs/legacy/v3/crm-commerce-subscriptions-v3.json) - [crm-communications-v3](/docs/specs/legacy/v3/crm-communications-v3.json) - [crm-companies-v3](/docs/specs/legacy/v3/crm-companies-v3.json) - [crm-companies-v2](/docs/specs/legacy/v2/crm-companies-v2.json) - [crm-companies-v1](/docs/specs/legacy/v1/crm-companies-v1.json) - [crm-contacts-v3](/docs/specs/legacy/v3/crm-contacts-v3.json) - [crm-contacts-v1](/docs/specs/legacy/v1/crm-contacts-v1.json) - [crm-contracts-v3](/docs/specs/legacy/v3/crm-contracts-v3.json) - [crm-courses-v3](/docs/specs/legacy/v3/crm-courses-v3.json) - [crm-custom-objects-v3](/docs/specs/legacy/v3/crm-custom-objects-v3.json) - [crm-deal-splits-v3](/docs/specs/legacy/v3/crm-deal-splits-v3.json) - [crm-deals-v3](/docs/specs/legacy/v3/crm-deals-v3.json) - [crm-deals-v1](/docs/specs/legacy/v1/crm-deals-v1.json) - [crm-discounts-v3](/docs/specs/legacy/v3/crm-discounts-v3.json) - [crm-feedback-submissions-v3](/docs/specs/legacy/v3/crm-feedback-submissions-v3.json) - [crm-fees-v3](/docs/specs/legacy/v3/crm-fees-v3.json) - [crm-forecasts-v3](/docs/specs/legacy/v3/crm-forecasts-v3.json) - [crm-forecast-types-v3](/docs/specs/legacy/v3/crm-forecast-types-v3.json) - [crm-goal-targets-v3](/docs/specs/legacy/v3/crm-goal-targets-v3.json) - [crm-invoices-v3](/docs/specs/legacy/v3/crm-invoices-v3.json) - [crm-leads-v3](/docs/specs/legacy/v3/crm-leads-v3.json) - [crm-line-items-v3](/docs/specs/legacy/v3/crm-line-items-v3.json) - [crm-line-items-v1](/docs/specs/legacy/v1/crm-line-items-v1.json) - [crm-listings-v3](/docs/specs/legacy/v3/crm-listings-v3.json) - [crm-object-library-v3](/docs/specs/legacy/v3/crm-object-library-v3.json) - [crm-objects-v3](/docs/specs/legacy/v3/crm-objects-v3.json) - [crm-orders-v3](/docs/specs/legacy/v3/crm-orders-v3.json) - [crm-partner-clients-v3](/docs/specs/legacy/v3/crm-partner-clients-v3.json) - [crm-partner-services-v3](/docs/specs/legacy/v3/crm-partner-services-v3.json) - [crm-products-v3](/docs/specs/legacy/v3/crm-products-v3.json) - [crm-products-v1](/docs/specs/legacy/v1/crm-products-v1.json) - [crm-projects-v3](/docs/specs/legacy/v3/crm-projects-v3.json) - [crm-quotes-v3](/docs/specs/legacy/v3/crm-quotes-v3.json) - [crm-schemas-v3](/docs/specs/legacy/v3/crm-schemas-v3.json) - [crm-services-v3](/docs/specs/legacy/v3/crm-services-v3.json) - [crm-taxes-v3](/docs/specs/legacy/v3/crm-taxes-v3.json) - [crm-tickets-v3](/docs/specs/legacy/v3/crm-tickets-v3.json) - [crm-tickets-v1](/docs/specs/legacy/v1/crm-tickets-v1.json) - [crm-users-v3](/docs/specs/legacy/v3/crm-users-v3.json)