Read
Read an object identified by objectId. By default, objectId refers to the internal object ID, but it can also be any unique property value specified by the idProperty query parameter. The response can be customized using the properties query parameter to include specific object properties.
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.
A boolean indicating whether this object is archived.
The date and time when this object was created, in ISO 8601 format.
The unique identifier for this object.
A map of property names to their current values.
The date and time when this object was last updated, in ISO 8601 format.
The date and time when this object was archived, in ISO 8601 format.
A map of associated object types to their corresponding collection of associated IDs.
An identifier for tracing the creation or update request of the object.
A map of property names to arrays of their historical values, each with a timestamp.
The URL for accessing this object.
An array of warnings related to this object, each containing a category, message, and context.