Pular para o conteúdo principal
GET
Ler

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

communicationId
string
obrigatório
Pattern: .+

Parâmetros de consulta

archived
boolean
padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

associations
string[]

Uma lista separada por vírgulas de tipos de objeto para recuperar IDs associados. Se alguma das associações especificadas não existir, ela será ignorada.

idProperty
string

O nome de uma propriedade cujos valores são exclusivos para este tipo de objeto

properties
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

propertiesWithHistory
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas junto com seu histórico de valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

Resposta

successful operation

Representa um objeto do CRM com suas propriedades, datas e horas, e um conjunto de IDs de objetos associados agrupados por tipo de associação.

archived
boolean
obrigatório

Um booleano que indica se o objeto do CRM está arquivado.

createdAt
string<date-time>
obrigatório

A data e a hora em que o objeto do CRM foi criado, no formato ISO 8601.

id
string
obrigatório

O identificador exclusivo do objeto do CRM.

properties
object
obrigatório

Um mapa de nomes de propriedades para seus valores atuais para o objeto do CRM.

updatedAt
string<date-time>
obrigatório

A data e a hora em que o objeto do CRM foi atualizado pela última vez, no formato ISO 8601.

archivedAt
string<date-time>

A data e a hora em que o objeto do CRM foi arquivado, no formato ISO 8601.

associations
object

Um mapa de tipos de objeto associados para seus respectivos IDs associados.

objectWriteTraceId
string

Um identificador de string usado para rastrear gravações no objeto do CRM.

propertiesWithHistory
object

Um mapa de nomes de propriedades para matrizes de valores históricos, cada um com uma data/hora, para o objeto do CRM.

url
string

O URL para acessar o objeto do CRM.

warnings
object[]

Uma matriz de avisos relacionados ao objeto do CRM, cada um contendo uma categoria, mensagem e contexto.

Última modificação em 6 de outubro de 2026