Zum Hauptinhalt springen
GET
Kontakte auflisten
Liefert gespeicherte Kontakte aus dem Workspace, zu dem dein API-Schlüssel gehört. Scan-Entwürfe werden erst berücksichtigt, wenn sie gespeichert wurden.

Sortierung wählen

Mit /contacts?sort=updatedAt&limit=25&offset=0 rufst du beispielsweise aktualisierte Kontakte ab.
sort=updatedAt lässt Kontakte aus, die noch nie aktualisiert wurden. Verwende createdAt, wenn du die vollständige Kontaktliste brauchst.

Weitere Kontakte abrufen

Jede Antwort enthält data und pagination. Verwende limit und offset, um die nächste Seite abzurufen, solange pagination.hasMore den Wert true hat. Beispiel zur Paginierung Die Antwort enthält Kontaktdaten, Tags, übermittelte Nachrichten, interne Notizen und das zugewiesene Teammitglied. updatedAt ist null, bis der Kontakt aktualisiert wurde.

Autorisierungen

Authorization
string
header
erforderlich

Unter Einstellungen → API-Schlüssel erstellter API-Schlüssel.

Abfrageparameter

limit
integer
Standard:100

Maximale Anzahl der Einträge pro Seite. Werte werden auf den Bereich 1–100 begrenzt; bei fehlenden oder ungültigen Zahlen wird 100 verwendet.

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

Anzahl der Einträge, die vor dieser Seite übersprungen werden. Negative Werte werden zu 0; bei fehlenden oder ungültigen Zahlen wird 0 verwendet.

Erforderlicher Bereich: x >= 0
sort
enum<string>
Standard:createdAt

createdAt gibt alle gespeicherten Kontakte zurück. updatedAt gibt nur Kontakte zurück, deren updatedAt nicht null ist. Beide sortieren die neuesten zuerst.

Verfügbare Optionen:
createdAt,
updatedAt

Antwort

Eine paginierte Kontaktliste

data
object[]
erforderlich
pagination
object
erforderlich

Informationen zum Blättern durch eine Ergebnisliste.