List
Leia uma página de objetos de um tipo especificado na sua conta HubSpot. Você pode controlar os dados retornados especificando propriedades, associações e se deve incluir registros arquivados. Este endpoint é útil para recuperar uma lista de objetos do CRM com detalhes e associações específicas.
Supported products
Supported products
Required Scopes
Required Scopes
Autorizações
The access token received from the authorization server in the OAuth 2.0 flow.
Parâmetros de caminho
O tipo de objeto do CRM a ser recuperado, como contatos, empresas ou negócios.
Parâmetros de consulta
Um token de cursor para paginação. Use o valor do campo paging.next.after da resposta anterior.
Indica se os registros arquivados devem ser incluídos na resposta. O padrão é falso.
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.
O número máximo de resultados a serem exibidos por página. O padrão é 10.
Uma lista de nomes de propriedades separadas por vírgulas para incluir na resposta. Se alguma das propriedades especificadas não estiver presente no(s) objeto(s) solicitado(s), ela será ignorada.
Uma lista de propriedades separadas por vírgulas a serem incluídas na resposta, juntamente com o histórico de seus valores anteriores. Se alguma das propriedades especificadas não estiver presente no(s) objeto(s) solicitado(s), ela será ignorada. 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.
Uma matriz de SimplePublicObjectWithAssociations, cada um representando um objeto do CRM com suas propriedades e dados associados.
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.