Skip to main content
GET
Read

Supported products

Parâmetros de caminho

taskId
string
obrigatório
Pattern: .+

Parâmetros de consulta

archived
boolean
padrão:false

Whether to return only results that have been archived.

associations
string[]

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.

idProperty
string

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

properties
string[]

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.

propertiesWithHistory
string[]

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.

Resposta

successful operation

Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.

archived
boolean
obrigatório

Whether the object is archived.

createdAt
string<date-time>
obrigatório

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

id
string
obrigatório

The unique ID of the object.

properties
object
obrigatório

Key value pairs representing the properties of the object.

updatedAt
string<date-time>
obrigatório

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

archivedAt
string<date-time>

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

associations
object

A map of associated object types to their associated IDs.

objectWriteTraceId
string

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

propertiesWithHistory
object

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

url
string

The URL link to access this object.

warnings
object[]
Última modificação em 13 de abril de 2026