Batch retrieve price books
Obtén un lote de objetos del CRM por sus ID internos o valores de propiedades únicos. Este punto de conexión permite especificar las propiedades y su historial para incluirlos en la respuesta. Es útil para obtener de forma eficiente los datos de varios objetos en una sola solicitud.
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 leerá en lote.
Parámetros de consulta
Si se devolverán solo los resultados que se han archivado.
Cuerpo
Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
Un conjunto de objetos SimplePublicObjectId, cada uno con el ID de un objeto del CRM para leer.
Un conjunto de cadenas que representan las propiedades que se devolverán en la respuesta. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.
Un conjunto de cadenas que representan las propiedades que se devolverán junto con su historial de valores anteriores. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará. El uso de este parámetro puede reducir el número máximo de objetos que se pueden leer en una sola solicitud.
Una cadena que representa el nombre de una propiedad cuyos valores son únicos para este tipo de objeto.
Respuesta
successful operation
A public object batch response object
La fecha y hora en que se completó la operación por lotes, en formato ISO 8601.
Un conjunto de elementos SimplePublicObject que representan los resultados de la operación por lotes.
La fecha y la hora en que comenzó la operación por lotes, en formato ISO 8601.
El estado actual de la operación por lotes. Los valores válidos son "PENDING", "PROCESSING", "CANCELED" y "COMPLETE".
CANCELED, COMPLETE, PENDING, PROCESSING Un mapa de nombres de enlaces a URI asociados que proporciona recursos o documentación adicionales relacionados con la operación por lotes.
La fecha y la hora en que se solicitó la operación por lotes, en formato ISO 8601.