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.
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 June 24th, 2025. Here is an example using the base name "vendor":
/crm/v3/objects/p_{object_name}
GET /crm/v3/objects/objectTypeId
GET /crm/v3/objects/fullyQualifiedName
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:
The implementation of this change will begin on June 18th, 2025, for existing portals currently referencing the path (GET/crm/v3/objects/{baseName}
), and will be completely disabled for all end users by June 24th, 2025.
Important Update (Date Change):
The release date for removing the undocumented support for requesting custom object types by their base name has been changed. The original date of April 29th, 2025, has moved to June 24th, 2025. Please update your systems and plans accordingly.
Questions or comments? Join us in the developer forums.