Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Listclean

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Listclean connection

    In AgentKit > Connections, create a Listclean connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. 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.actions
    const connector = 'listclean'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { 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 call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'listclean_account_profile_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each 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 to execute_tool
Try in PlaygroundRequest a tool
  • listclean_account_profile_getGet your Listclean account profile.Read-only

    Get 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-only

    Get 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-only

    Get 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-only

    Get 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-only

    List 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-only

    Get 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-only

    List 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-only

    Get 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