List
Lee una página de objetos de un tipo específico en tu cuenta de HubSpot. Puedes controlar los datos que se devuelven especificando propiedades, asociaciones y si quieres incluir registros archivados. Este punto de terminación es útil para obtener una lista de objetos del CRM con detalles y asociaciones específicos.
Supported products
Supported products
Required Scopes
Required Scopes
Autorizaciones
The access token received from the authorization server in the OAuth 2.0 flow.
- Authorization URL
- https://app.hubspot.com/oauth/authorize
- Token URL
- https://api.hubapi.com/oauth/v1/token
Parámetros de ruta
El tipo de objeto del CRM que se obtendrá, como contactos, empresas o negocios.
Parámetros de consulta
Un token de cursor para la paginación. Usa el valor del campo paging.next.after de la respuesta anterior.
Si se deben incluir o no los registros archivados en la respuesta. El valor predeterminado es falso.
Una lista de tipos de objetos separados por comas para recuperar los ID asociados. Si alguna de las asociaciones especificadas no existe, se ignorará.
El número máximo de resultados que se mostrarán por página. La opción predeterminada es 10.
Una lista de nombres de propiedades separados por comas para incluir en la respuesta. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.
Una lista de propiedades separadas por comas para incluir en la respuesta junto con su historial de valores anteriores. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará. Usar este parámetro reduce el número máximo de objetos que se pueden leer en una sola solicitud.
Respuesta
successful operation
Representa una respuesta de colección paginada que incluye objetos públicos simples con sus asociaciones. Este componente se usa para manejar los resultados y los detalles de paginación al recuperar una lista de objetos de la API.
Un conjunto de SimplePublicObjectWithAssociations, cada uno representando un objeto del CRM con sus propiedades y datos asociados.
Información de paginación para la paginación de solo avance. Contiene la referencia a la página siguiente cuando hay más resultados disponibles; se omite o está vacía en la última página.