Read
Read an object identified by {objectId} in the HubSpot CRM. By default, {objectId} refers to the internal object ID, but you can specify any unique property value using the idProperty query parameter. Customize the response by selecting specific properties with the properties query parameter. This endpoint is useful for retrieving detailed information about a specific CRM object, including its properties, history, associations, and archived status.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
.+Query Parameters
Whether to return only results that have been archived.
A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
The name of a property whose values are unique for this object type
A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
Response
successful operation
Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
Indicates whether the object is archived. A boolean value.
The date and time when the object was created, in ISO 8601 format.
The unique identifier for the CRM object.
A map of property names to their current values for the object.
The date and time when the object was last updated, in ISO 8601 format.
The date and time when the object was archived, in ISO 8601 format.
A map of associated object types to their respective associated IDs.
An identifier for tracing the write operations on the object.
A map of property names to arrays of historical values, each with a timestamp.
The URL link to access the object.
An array of warnings related to the object, each containing a category, message, and context.