Pular para o conteúdo principal
GET
Ler

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

contractId
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

Booleano que indica se este objeto foi arquivado.

createdAt
string<date-time>
obrigatório

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

id
string
obrigatório

O identificador exclusivo deste objeto.

properties
object
obrigatório

Um mapa dos nomes das propriedades para seus valores atuais para o objeto.

updatedAt
string<date-time>
obrigatório

A data e a hora da última atualização deste objeto, no formato ISO 8601.

archivedAt
string<date-time>

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

associations
object

Um mapa de tipos de objeto associados para seu respectivo conjunto de IDs associados.

objectWriteTraceId
string

Um identificador usado para rastrear as operações de gravação neste objeto.

propertiesWithHistory
object

Um mapa dos nomes das propriedades para seus valores, juntamente com um histórico de alterações, representados como matrizes de valores com data/hora.

url
string

Link do URL para acessar este objeto.

warnings
object[]

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

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