Pular para o conteúdo principal
GET
Recuperar itens do catálogo de preços

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

objectType
string
obrigatório

O tipo de objeto do CRM a ser recuperado, como contatos, empresas ou negócios.

Parâmetros de consulta

after
string

Um token de cursor para paginação. Use o valor do campo paging.next.after da resposta anterior.

archived
boolean
padrão:false

Indica se devem ser incluídos apenas os resultados arquivados. O padrão é falso.

associations
string[]

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

limit
integer<int32>
padrão:10

O número máximo de resultados a serem exibidos por página. O padrão é 10.

properties
string[]

Uma lista de nomes de propriedades separadas por vírgulas para incluir na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, será ignorada.

propertiesWithHistory
string[]

Uma lista de propriedades separadas por vírgulas a serem retornadas junto com o histórico de valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, elas serão ignoradas. O uso deste parâmetro reduz o número máximo de objetos que podem ser lidos em uma única solicitação.

Resposta

successful operation

Representa uma resposta de conjunto paginado que inclui objetos públicos simples com suas associações. Este componente é usado para lidar com os resultados e detalhes de paginação ao recuperar uma lista de objetos da API.

results
object[]
obrigatório

Uma matriz de SimplePublicObjectWithAssociations, que representa os objetos do CRM recuperados na página atual de resultados.

paging
object

Informações de paginação para paginação somente para frente. Contém a referência da próxima página quando há mais resultados disponíveis; é omitida ou fica vazia na última página.

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