The Listclean connector lets your AI agent act in each user's Listclean account. Each user connects their own Listclean API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 12 tools.
- Tools
- 12
- What they doRead · write · destructive
- 9 · 2 · 19 read2 write1 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Listclean connection
In AgentKit > Connections, create a Listclean connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'listclean'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Listclean:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'listclean_account_profile_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "listclean"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Listclean:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="listclean_account_profile_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Listclean credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toollistclean_account_profile_getGet your Listclean account profile.Read-onlyGet Account Profile
Get your Listclean account profile. Returns your name, email, company and billing details. Use credits_get for the remaining balance.
Inputs
This tool takes no inputs.
listclean_credits_getGet your remaining Listclean verification credits.Read-onlyGet Credits
Get your remaining Listclean verification credits. Returns the credit balance. Each verified address uses one credit.
Inputs
This tool takes no inputs.
listclean_list_getGet one email list's details.Read-onlyGet Email List
Get one email list's details. Returns its name, status, progress and clean, dirty and unknown counts. Use list_results_get to download its addresses.
Inputs
list_idintegerrequired- ID of the list (a CSV upload or batch). Get it from lists_list. Example: 1024.
listclean_list_results_getDownload the addresses of a finished list that fall in one result type (clean, dirty or unknown), as JSON.Read-onlyGet Email List Results
Download the addresses of a finished list that fall in one result type (clean, dirty or unknown), as JSON. Returns the matching email records with their status details. Run once per type you need.
Inputs
list_idintegerrequired- ID of the list (a CSV upload or batch). Get it from lists_list. Example: 1024.
typestringrequired- A type can be clean, dirty, unknown. Example: clean.one of
cleandirtyunknown
listclean_lists_listList your verified email lists (from CSV uploads and batch verifications).Read-onlyList Email Lists
List your verified email lists (from CSV uploads and batch verifications). Returns each list's id, name, status, progress and clean, dirty and unknown counts. Use list_get for one list.
Inputs
This tool takes no inputs.
listclean_upload_getGet the status of one CSV upload.Read-onlyGet Upload
Get the status of one CSV upload. Returns its filename, status, chunks received and the list it created. Use uploads_list to find upload IDs.
Inputs
upload_idintegerrequired- ID of the upload. Get it from uploads_list. Example: 512.
listclean_uploads_listList your CSV uploads.Read-onlyList Uploads
List your CSV uploads. Returns each upload's id, filename, status and chunk progress. Use upload_get for one upload.
Inputs
This tool takes no inputs.
listclean_verification_analytics_getGet email verification totals for a date range, overall and per day.Read-onlyGet Verification Analytics
Get email verification totals for a date range, overall and per day. Returns counts of clean, dirty, unknown and error results. Use verification_logs_list for individual records.
Inputs
end_datestringrequired- End date of the report range. It cannot be in the future. Example: 2026-11-05.
start_datestringrequired- Start date of the report range. Example: 2026-11-01.
sourcestring- Optional verification-source filter. Example: api.one of
apifile_uploadsingle_email statusstring- Optional verification-status filter. Example: clean.one of
cleandirtyunknownerror
listclean_verification_logs_listList single-email verification logs over a date range of up to 30 days, with filters and paging.Read-onlyList Verification Logs
List single-email verification logs over a date range of up to 30 days, with filters and paging. Returns each log's email, status, source and time. Use verification_analytics_get for totals.
Inputs
end_datestringrequired- End date of the report range. It cannot be in the future. Example: 2026-11-05.
start_datestringrequired- Start date of the report range. The maximum date range is 30 days. Example: 2026-11-01.
emailstring- Optional email-address filter. Example: jane@example.com.
limitinteger- Maximum number of log records to return. Defaults to 10. Example: 10.
sourcestring- Optional verification-source filter. Example: api.one of
apifile_uploadsingle_email startinteger- Zero-based pagination offset. Defaults to 0. Example: 0.
statusstring- Optional verification-status filter. Example: clean.one of
cleandirtyunknownerror
listclean_email_verifyVerify one email address.WriteVerify Email
Verify one email address. Uses one verification credit. Returns the address's status (clean, dirty or unknown) and the reasons behind it. Use emails_verify_batch for many addresses at once.
Inputs
emailstringrequired- The email address to verify. Example: jane@example.com.
listclean_emails_verify_batchSubmit up to 3,000 email addresses for verification as one list.WriteVerify Emails in Batch
Submit up to 3,000 email addresses for verification as one list. Uses one credit per address. Returns the created list's id and status; results are ready when list_get shows it finished. Use list_results_get to download the clean, dirty or unknown addresses.
Inputs
emailsarrayrequired- Email addresses to verify. The default limit is 3,000 addresses per request. Example: ["user1@example.com", "user2@example.com"]
filenamestring- Optional source filename. If omitted, the API generates a UTC filename in the format batch_upload-DD-MM-YYYY-HHMMSS-utc.csv (for example, batch_upload-05-10-2026-143025-utc.csv). A .csv extension is added when a supplied filename has no extension. Example: october-leads.csv.
listclean_list_deleteDelete an email list and its results.DestructiveDelete Email List
Delete an email list and its results. Returns the result. Download results first if you need them.
- Idempotent
Inputs
list_idintegerrequired- ID of the list (a CSV upload or batch). Get it from lists_list. Example: 1024.
No tools match.