Skip to main content
Listclean logo
  • Category: email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: LISTCLEAN
  • Version: 20261101_00

Tools

Slug: LISTCLEAN_CREATE_BULK_VERIFICATION_LISTTool to create a CSV file with provided email addresses for bulk verification. Use when you need to generate a file for bulk upload through LISTCLEAN_UPLOAD_LIST.

Input Parameters

array
required
List of valid email addresses to include in the CSV file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_DELETE_LISTTool to permanently delete a single list from the account. Use when you need to remove a list that is no longer needed.

Input Parameters

integer
required
The unique identifier of the list to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_DOWNLOAD_CSVTool to download list results as a CSV file. Use when you need to retrieve verification results filtered by email type (clean, dirty, or unknown).

Input Parameters

string ("clean" | "dirty" | "unknown")
required
Type of emails to download: ‘clean’ for valid emails, ‘dirty’ for invalid emails, or ‘unknown’ for unverified emails
integer
required
The ID of the email verification list to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_DOWNLOAD_JSONTool to download list results as JSON. Downloads emails filtered by type (clean, dirty, or unknown) in JSON format. Use after list verification is complete to retrieve filtered results.

Input Parameters

string ("clean" | "dirty" | "unknown")
required
Type of emails to download from the list
integer
required
Unique identifier of the list to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_GET_ACCOUNT_PROFILETool to retrieve the authenticated account’s profile. Use after obtaining a valid auth token to fetch user account data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_GET_CREDITSRetrieve the account’s remaining email verification credits. Use this to check the available balance before performing more verifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_GET_LISTTool to retrieve detailed information for a specific list. Returns analytics with clean/dirty breakdown, cost details, and processing status.

Input Parameters

integer
required
Unique identifier of the list to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_GET_UPLOAD_STATUSTool to retrieve the status of a specific upload. Returns upload status (inprocess, success, error), progress percentage, and chunk details. Use after initiating an upload to track its completion.

Input Parameters

integer
required
Unique identifier of the upload to check status for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_GET_VERIFICATION_LOGSRetrieve a page of single-email verification logs, including status, remarks, credits deducted, and timestamps.

Input Parameters

integer
Offset for pagination. 0-based index of the first log entry to return.
integer
Number of log entries to return per page (default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_LIST_ALLRetrieve email verification lists with analytics, clean and dirty counts, and cost information. The response may include a pagination cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_LIST_UPLOADSRetrieve a page of CSV uploads to check upload IDs, status, and progress in your account.

Input Parameters

integer
Offset for pagination. 0-based index of the first upload to return.
integer
Number of uploads to return per page (default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_START_UPLOADTool to start a CSV upload process for bulk email verification. Initializes chunked file upload and returns an upload_id for subsequent chunk uploads. Use when you need to upload large CSV files containing email addresses.

Input Parameters

string
required
Name of the CSV file to upload
string
required
Type of file being uploaded (must be ‘csv’)
string
The optional escape parameter sets the escape character (at most one single-byte character). An empty value disables the escape mechanism
integer
Option to process list as fast as possible by avoiding slow operations like SMTP validation. 0 = off (default), 1 = on
string
The optional enclosure parameter sets the field enclosure character (one single-byte character only)
integer
required
Maximum size of a chunk in bytes
string
Character separator for CSV file format
integer
required
Total number of chunks the file will be split into for upload
integer
required
Zero-based index of the column containing email addresses in the CSV file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_UPDATE_PROFILETool to update account profile details. Use when you need to modify user profile information such as name, address, contact details, company information, or billing details.

Input Parameters

string
User’s city
string
First name of the user
string
User’s address
string
User’s country
string
User’s website
string
User’s LinkedIn profile URL or handle
string
User’s Skype ID
string
Billing name for invoices and payments
string
User’s company name
string
User’s phone number
string
User’s Twitter handle
string
Billing address for invoices and payments
string
Billing company name for invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_UPLOAD_CHUNKTool to upload a chunk of a CSV file. Use when sending base64-encoded content with sequence number as part of chunked upload process, optionally with MD5 checksum for integrity verification.

Input Parameters

string
required
Base64-encoded contents of the file chunk
integer
required
The upload ID obtained from starting the upload process
string
MD5 hash of file to check the integrity of the file chunk
integer
required
Sequence number of the chunk, starting at 1 for the first chunk

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_VERIFY_BATCHTool to verify a batch of email addresses (max 3000 emails). Use when you need to verify multiple emails at once and get a list_id for tracking the batch verification request.

Input Parameters

array
required
List of email addresses to verify (maximum 3000 emails per batch)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LISTCLEAN_VERIFY_EMAILVerify a single email address and return its verification status and any remarks. Use to assess validity and potential delivery risks after collecting an address.

Input Parameters

string
required
The email address to verify

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not