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/listsAuthentifizierung
Section titled “Authentifizierung”Übergib deinen API-Schlüssel als Bearer-Token im Authorization-Header. Schlüssel folgen dem Format hw_XXXXXXXXXXX.
Anfrage
Section titled “Anfrage”Der Body wird als application/json gesendet. action ist Pflicht.
| Parameter | Typ | Beschreibung |
|---|---|---|
action | enumstring | create, add, remove, get, list oder delete. |
list_id | string | ID der Liste, Pflicht bei add, remove, get und delete. |
name | string | Name der Liste, Pflicht bei create. |
type | enumstring | companies (Standard) oder contacts. |
domains | string[] | Domains zum Hinzufügen oder Entfernen, bis zu 10.000 pro Call. |
emails | string[] | E-Mails oder LinkedIn-URLs bei Kontaktlisten. |
tags | string[] | Tags zur Organisation, z. B. ["crm", "ausschluss"]. |
limit | integer | Bei get: Anzahl der Einträge pro Seite (Standard: 1.000). |
cursor | string | Bei get: Cursor für die nächste Seite. |
Beispiel
Section titled “Beispiel”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" ]}'Antwort
Section titled “Antwort”{ "list_id": "lst_crm_bestandskunden", "name": "CRM Bestandskunden", "type": "companies", "size": 2, "added": 2, "duplicates": 0, "status": "ok"}| Feld | Typ | Beschreibung |
|---|---|---|
list_id | string | ID der Liste, verwendbar als list_id oder exclude_list_id in allen Endpunkten. |
size | integer | Anzahl der Einträge nach der Operation. |
added | integer | Neu hinzugefügte Einträge. |
duplicates | integer | Übersprungene Dubletten. |
status | string | Status der Anfrage. |