Sign in

v7

latestOpenAPI 3.0.12026-07-131134150.6 KB
Basic

Retrieve a subscription

Retrieve a specific subscription by its ID, including its properties and associations.

get/crm/objects/2026-09/{objectType}/{objectId}

Path parameters

objectIdstring required

Subscription Object Id

objectTypestring required

Object type.

Query parameters

archivedboolean

Whether to return only archived results.

associationsstring[]

A list of associated object types to include in the response.

idPropertystring

The name of a unique identifier property, which can be used for identifying objects instead of the object ID.

propertiesstring[]

A list of property names to include in the response.

propertiesWithHistorystring[]

A list of property names to include in the response, along with their history.

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.