Zum Hauptinhalt springen
GET
curl

Überblick

Gibt eine paginierte Liste der Unternehmens-Entitäten für die authentifizierte Anwendung zurück.

Wann verwenden

  • Synchronisieren Sie Ihre Unternehmenstabelle mit einem externen BI-System oder Data Warehouse.
  • Analysten-Warteschlangen: Filtern Sie nach status=FLAGGED, um einen Prüfungs-Posteingang zu speisen.
  • Suchen Sie nach display_name, legal_name, registration_number oder vendor_data.

Filter und Paginierung

Hinweise

  • vendor_data kann null sein, wenn die ursprüngliche Sitzung oder Transaktion keine Daten geliefert hat.
  • Cursor-basierte Paginierung: Speichern Sie den next-Cursor zwischen den Aufrufen.
  • Alle Felder finden Sie im Datenmodell Unternehmen.

Berechtigungen

Die Rolle muss list:businesses gewähren.

Verwandte Themen

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Abfrageparameter

limit
integer
Standard:50

Seitengröße. Standardmäßig 50, wenn nicht angegeben. Es gibt kein festes Maximum, aber halten Sie die Seiten klein, um die Latenz gering zu halten.

Erforderlicher Bereich: 1 <= x <= 1000000
offset
integer
Standard:0

Nullbasierter Offset des ersten zurückzugebenden Datensatzes. Folgen Sie vorzugsweise der next-URL der vorherigen Seite, statt diesen Wert manuell zu berechnen.

Erforderlicher Bereich: 0 <= x <= 1000000

Antwort

Paginierte Liste von Unternehmen mit Status, Sitzungsanzahl und Aufschlüsselung der Funktionen.

count
integer

Anzahl der übereinstimmenden Zeilen – exakt bis 100, darüber hinaus aus Performancegründen auf 100 begrenzt. Verwenden Sie diesen Wert nicht, um die letzte Seite zu erkennen; verlassen Sie sich stattdessen darauf, dass next null ist.

next
string | null

Absolute URL der nächsten Seite oder null auf der letzten Seite.

previous
string | null

Absolute URL der vorherigen Seite oder null auf der ersten Seite.

results
object[]
Zuletzt geändert am 7. November 2026