Retrieve price book items
Récupérer une page d’objets CRM d’un type spécifié. Vous pouvez contrôler les données renvoyées en spécifiant les propriétés, les associations et si les fiches d’informations archivées doivent être incluses. Ce point de terminaison est utile pour récupérer une liste d’objets avec des attributs ou des associations spécifiques.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
The access token received from the authorization server in the OAuth 2.0 flow.
Paramètres de chemin
Le type d'objet CRM à récupérer, tel que les contacts, les entreprises ou les transactions.
Paramètres de requête
Un jeton de curseur pour la pagination. Utilisez la valeur du champ paging.next.after de la réponse précédente.
S'il faut inclure uniquement les résultats qui ont été archivés. La valeur par défaut est faux.
Une liste d'objets séparés par des virgules pour lesquels les ID associés doivent être récupérés. Si des associations spécifiées n'existent pas, elles seront ignorées.
Le nombre maximal de résultats à afficher par page. La valeur par défaut est 10.
Une liste de noms de propriétés séparés par des virgules à inclure dans la réponse. Si les propriétés spécifiées ne sont pas présentes sur les objets demandés, elles seront ignorées.
Une liste de propriétés séparées par des virgules à renvoyer avec l'historique de leurs valeurs précédentes. Si les propriétés spécifiées ne sont pas présentes sur les objets demandés, elles seront ignorées. L'utilisation de ce paramètre réduit le nombre maximal d'objets pouvant être lus en une seule requête.
Réponse
successful operation
Représente une réponse de collection paginée qui inclut des objets publics simples avec leurs associations. Ce composant est utilisé pour gérer les résultats et les détails de pagination lors de la récupération d'une liste d'objets à partir de l'API.
Un tableau de SimplePublicObjectWithAssociations, représentant les objets CRM récupérés sur la page de résultats actuelle.
Informations de pagination pour une pagination unidirectionnelle. Contient la référence de la page suivante lorsque d'autres résultats sont disponibles ; omis ou vide sur la dernière page.