Sign in
Basic

Read

Read an Object identified by {quoteId}. {quoteId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

get/crm/v3/objects/quotes/{quoteId}

Path parameters

quoteIdstring required

Query parameters

archivedboolean

Whether to return only results that have been archived.

associationsstring[]

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.

idPropertystring

The name of a property whose values are unique for this object type

propertiesstring[]

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.

propertiesWithHistorystring[]

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

archivedboolean required

Whether the object is archived.

archivedAtstring date-time

The timestamp when the object was archived, in ISO 8601 format.

associationsobject

A list defining relationships with other objects.

createdAtstring date-time required

The timestamp when the object was created, in ISO 8601 format.

idstring required

The unique ID of the object.

objectWriteTraceIdstring

An identifier used for tracing the creation or update request of the object.

propertiesobject required

Key value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring date-time required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL on the API that provide direct navigation to the corresponding UI pages for the connectors.

Changes

Changed in 12 of the 55 revisions of this API.2126

  • v3d6ec776435571See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3667c4d0453e01See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3ad43b36073722See the full diff
    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

  • v3ad43b36073723See the full diff
    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v3a0dbba00d7b5112See the full diff
    • ▲

      removed the required property //// from the response with the status

      response-required-property-removed

    • ●

      removed the optional property //// from the response with the status

      response-optional-property-removed

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3abcf6606c8703See the full diff
    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      the response property //// became required for the status

      response-property-became-required

  • v366b6f28000354See the full diff
    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v32906ea325a382See the full diff
    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

  • v3a0dbba00d7b52See the full diff
    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

  • v39703d508effe1See the full diff
    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog