Skip to content

Listen (lists)

Listen verbinden die Schritte deines Workflows: Eine Discovery-Suche speichert ihr Ergebnis als Liste, die nächste Suche schließt sie aus, validate_icp prüft sie, discover_people zieht Kontakte daraus.

Typische Listen: dein CRM (als Ausschluss), bereits kontaktierte Firmen, ein Segment, eine geprüfte Zielliste.

Der Endpunkt nimmt eine action entgegen: create, add, remove, get, list oder delete.

Nutze diesen Endpunkt, um:

  • dein CRM oder deine Bestandskunden einmal hochzuladen und in jeder Suche auszuschließen
  • eine Liste schrittweise zu erweitern, ohne Dubletten
  • Ergebnisse zwischen Discovery, Refinement und Enrichment weiterzureichen

Kostenlos: Listen-Operationen zählen nicht gegen dein Fair-Use-Kontingent.

POST https://api.hiwalter.de/api/v1/tools/lists

Übergib deinen API-Schlüssel als Bearer-Token im Authorization-Header. Schlüssel folgen dem Format hw_XXXXXXXXXXX.

Der Body wird als application/json gesendet. action ist Pflicht.

ParameterTypBeschreibung
actionenumstringcreate, add, remove, get, list oder delete.
list_idstringID der Liste, Pflicht bei add, remove, get und delete.
namestringName der Liste, Pflicht bei create.
typeenumstringcompanies (Standard) oder contacts.
domainsstring[]Domains zum Hinzufügen oder Entfernen, bis zu 10.000 pro Call.
emailsstring[]E-Mails oder LinkedIn-URLs bei Kontaktlisten.
tagsstring[]Tags zur Organisation, z. B. ["crm", "ausschluss"].
limitintegerBei get: Anzahl der Einträge pro Seite (Standard: 1.000).
cursorstringBei get: Cursor für die nächste Seite.
Terminal window
curl --request POST \
--url https://api.hiwalter.de/api/v1/tools/lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "create",
"name": "CRM Bestandskunden",
"type": "companies",
"domains": [
"kunde-eins.de",
"kunde-zwei.de"
],
"tags": [
"crm",
"ausschluss"
]
}
'
{
"list_id": "lst_crm_bestandskunden",
"name": "CRM Bestandskunden",
"type": "companies",
"size": 2,
"added": 2,
"duplicates": 0,
"status": "ok"
}
FeldTypBeschreibung
list_idstringID der Liste, verwendbar als list_id oder exclude_list_id in allen Endpunkten.
sizeintegerAnzahl der Einträge nach der Operation.
addedintegerNeu hinzugefügte Einträge.
duplicatesintegerÜbersprungene Dubletten.
statusstringStatus der Anfrage.