v4

latestOpenAPI 3.0.12026-07-1352145.3 KB

Basic

Retrieve a partner client

Retrieve detailed information about a specific partner client, including selected properties and associations. This endpoint is useful for accessing comprehensive client data for analysis or integration purposes.

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

Path parameters

objectIdstring required

Unique Partner Client Id

objectTypestring required

Object type.

Query parameters

archivedboolean

Indicates whether to include deleted partner clients in the response.

associationsstring[]

A list of association types to include in the response.

idPropertystring

Specifies the unique identifier property used to identify the partner client.

propertiesstring[]

A list of properties to include in the response.

propertiesWithHistorystring[]

A list of properties to include in the response, along with their historical values.

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.