List
Rufen Sie eine Seite mit CRM-Objekten eines bestimmten Typs ab. Sie können die zurückgegebenen Daten steuern, indem Sie bestimmte Eigenschaften und Zuordnungen angeben und festlegen, ob archivierte Datensätze eingeschlossen werden sollen. Dieser Endpunkt ist nützlich, um eine Liste von Objekten mit bestimmten Attributen und Zuordnungen abzurufen.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisierungen
The access token received from the authorization server in the OAuth 2.0 flow.
Abfrageparameter
Das Paging-Cursor-Token der zuletzt erfolgreich gelesenen Ressource wird als „paging.next.after“-JSON-Eigenschaft einer paginierten Antwort mit weiteren Ergebnissen zurückgegeben.
Ob nur Ergebnisse zurückgegeben werden sollen, die archiviert wurden.
Eine durch Kommas getrennte Liste der Objekttypen, für die zugeordnete IDs abgerufen werden sollen. Wenn angegebene Zuordnungen nicht existieren, werden sie ignoriert.
Die maximale Anzahl der Ergebnisse, die pro Seite angezeigt werden.
Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn angegebene Eigenschaften in dem oder den angeforderten Objekten nicht vorhanden sind, werden sie ignoriert.
Eine durch Kommas getrennte Liste der Eigenschaften, die zusammen mit den jeweiligen Verlaufswerten zurückgegeben werden sollen. Wenn Eigenschaften in dem oder den angeforderten Objekten nicht vorhanden sind, werden sie ignoriert. Mit diesem Parameter wird die maximale Anzahl der Objekte reduziert, die bei einer einzigen Anfrage gelesen werden können.
Antwort
successful operation
Stellt eine paginierte Sammlungsantwort dar, die einfache öffentliche Objekte mit ihren Zuordnungen enthält. Diese Komponente wird verwendet, um die Ergebnisse und Paginierungsdetails beim Abrufen einer Liste von Objekten aus der API zu verwalten.
Ein Array von einfachen öffentlichen Objekten mit Zuordnungen. Jedes Objekt enthält seine Eigenschaften, Zuordnungen und Metadaten.
Seitennummerierungsinformationen für die Nur-Vorwärts-Paginierung. Enthält eine Referenz für die nächste Seite, wenn weitere Ergebnisse verfügbar sind; wird auf der letzten Seite weggelassen oder ist leer.