Retrieve a price book
Read an object identified by {objectId}. By default, {objectId} refers to the internal object ID, but you can specify any unique property value using the idProperty query parameter. Use the properties query parameter to control which properties are returned in the response.
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
The unique identifier of the object to read.
The type of the object to read.
Query Parameters
Whether to return only results that have been archived. Defaults to false.
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, represented as a string.
A map of property names to their values, where each value is a string.
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 collection of associated IDs.
A string representing the trace ID for the object write operation.
A map of property names to their historical values, where each value is an array of objects containing the value and timestamp.
A string representing the URL of the object.
An array of warnings related to the object, each containing a category, message, and context.