Sign in
Basic

Read

Read an Object identified by {contractId}. {contractId} 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/contracts/{contractId}

Path parameters

contractIdstring 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 7 of the 56 revisions of this API.2110

  • v3fb2da1434d001See 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

  • v38c459c7adcf81See the full diff
    • ○

      added the optional property warnings to the response with the 200 status

      response-optional-property-added

  • v3827038b5099e11See the full diff
    • ▲

      removed the required property associations/additionalProperties/results/items/associationSpec from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property associations/additionalProperties/results/items/toOffset from the response with the 200 status

      response-optional-property-removed

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

  • v32f950cda67051See the full diff
    • ○

      the response property associations/additionalProperties/results/items/associationSpec became required for the status 200

      response-property-became-required

  • v38fac3d8fec952See the full diff
    • ○

      added the optional property associations/additionalProperties/results/items/associationSpec to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property associations/additionalProperties/results/items/toOffset to the response with the 200 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

  • v36a142fabc6135See the full diff
    • ○

      the endpoint scheme security oauth2 was added to the API

      api-security-added

    • ○

      the endpoint scheme security app_cookie was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security hapikey was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security internal_cookie was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security shhkey was removed from the API

      api-security-removed

  • v3ad6b00f1dceb1See the full diff
    • ○

      endpoint added

      endpoint-added

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