Breaking Change: Removed Support for Referencing Custom Object Types by Base Name

We are removing the undocumented support for requesting custom object types by their base name (GET/crm/v3/objects/{baseName}) in HubSpot public APIs. All custom object types must be referenced by their unique identifier (object type ID, fully qualified name, or short-hand custom object type name) to ensure clarity and consistency in API interactions.

What's changing?

Previously, it was possible to refer to custom object types by their base name in API requests. For instance, if both a HubSpot-defined object type and a custom object type were named "vendor," using the base name would cause confusion and result in unexpected behavior in API responses.
As a result, the base name format will no longer be supported after April 29th, 2025. Here is an example using the base name "vendor":

Instead, you must use one of the following formats for your request:

• Using the short-hand custom object type name, aka GET /crm/v3/objects/p_{object_name}

• Using the GET /crm/v3/objects/objectTypeId

• Using the GET /crm/v3/objects/fullyQualifiedName

What does this mean for developers?

Failing to update your custom object type API calls that refer to their base name instead of their unique identifier (object type ID, fully qualified name, or short-hand custom object type name) will result in unexpected errors or a failed request, returning a 400 error response:

We recommend the following next steps:

• Review and update your API integrations to ensure that all API requests to custom object types comply with the documented requirements and no longer refer to a custom object type by its base name.
• Please refer to our API Documentation for more information on retrieving custom object type data and understanding the available reference formats.

When is it happening?

This change will go into effect on April 29th, 2025.

Questions or comments? Join us in the developer forums.