Skip to main content
POST
Récupérer un lot d'entreprises

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de requête

archived
boolean
défaut:false

S'il faut renvoyer uniquement les résultats qui ont été archivés.

Corps

application/json

Spécifie l'entrée pour la lecture d'un lot d'objets CRM, y compris des tableaux d'ID d'objets, les noms de propriétés demandés (avec historique facultatif) et une propriété d'identification unique facultative.

inputs
object[]
requis

Un tableau d'objets SimplePublicObjectId, chacun contenant un ID qui spécifie les objets CRM à lire dans l'opération par lots.

properties
string[]
requis

Un tableau de chaînes de caractères représentant les propriétés à renvoyer pour chaque objet dans l'opération de lecture par lots.

propertiesWithHistory
string[]
requis

Un tableau de chaînes de caractères représentant les propriétés à renvoyer, ainsi que l'historique de leurs valeurs précédentes, pour chaque objet de l'opération de lecture par lots.

idProperty
string

Lors de l'utilisation d'une propriété à valeur unique personnalisée, pour récupérer les fiches d'informations, le nom de la propriété. Ne pas inclure ce paramètre si l'extraction se fait par l'ID de la fiche d'informations.

Réponse

successful operation

Objet de réponse de lot d'objet public

completedAt
string<date-time>
requis

La date et l'heure auxquelles l'opération de lot a été effectuée, au format ISO 8601.

results
object[]
requis

Un tableau d'éléments SimplePublicObject qui représentent les résultats de l'opération par lot.

startedAt
string<date-time>
requis

La date et l'heure auxquelles l'opération par lot a commencé, au format ISO 8601.

status
enum<string>
requis

Statut de la demande de traitement par lots. La valeur attendue est « TERMINÉ ».

Options disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

Une carte des noms de liens vers les URI associées, fournissant des informations ou des actions supplémentaires liées à l'opération de lot.

requestedAt
string<date-time>

La date et l'heure auxquelles l'opération de lot a été demandée, au format ISO 8601.

Dernière modification le 6 octobre 2026