v1

latestOpenAPI 3.0.12026-07-13103041.6 KB
Basic

Read

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

Path parameters

bucketTest111Idstring required

Query parameters

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.

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.

archivedboolean

Whether to return only results that have been archived.

idPropertystring

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

Response

successful operation

associationsobject
createdAtstring date-time required
archivedboolean
archivedAtstring date-time
propertiesWithHistoryobject
idstring required
propertiesobject required
updatedAtstring date-time required