ListCleanerDeveloper platform
GET/show_lists

Show all email cleaning jobs

Retrieve the authenticated account's retained list-cleaning jobs and their current processing information.

JSON responseJob monitoringNo request body
Temporary tab credentials

Authenticate once for every guide

Your email and API key remain in this tab's session storage, work across all request pages, and disappear when the tab closes.

Credentials have not been entered.

Overview

What this request does

The show-lists request provides the job inventory used to build dashboards, operational monitors and automated polling workflows. Without a UID query parameter, the endpoint returns the retained jobs associated with the authenticated ListCleaner account.

Each job can include its UID, creation time, original filename, total records, current step, status and most recent status update. Use the UID to transition from an account-level overview to one specific job or its downloadable result files.

Implementation workflow

How to use /show_lists

Authenticate

Send the account email and API key headers.

Request the collection

Call GET /show_lists without a UID query parameter.

Use each UID

Store or display the job status and link completed jobs to the appropriate download request.

Request contract

Headers, parameters and fields

NameLocationRequiredDescription
X-User-EmailHeaderYesEmail address belonging to the ListCleaner API account.
X-Api-KeyHeaderYesSecret API key for the authenticated ListCleaner account.

Response behavior

  • The lists array contains retained cleaning jobs.
  • current_status and current_step describe processing progress.
  • last_status_update can be used to show freshness in a dashboard.
Interactive API console

Execute this request

Edit the request values, then send a live authenticated request to ListCleaner. The HTTP status and duration appear in the response bar, with the actual API response body directly below. File endpoints provide a download link instead of printing binary data.

Your saved tab credentials are added to the request headers and never printed in the response panel.
This performs a real API operation and may use credits or change account data.
Ready-to-run examples

Code examples in 10 languages

After credentials are entered above, every example includes the actual account email and API key so the copied request can run immediately. Clear the credentials to return to placeholders.

GET /show_listsContent type:
PHP
Integration guidance

Use cases and best practices

Common use cases

  • Populate an account dashboard with cleaning history.
  • Monitor active jobs from a backend scheduler.
  • Locate a UID before downloading a completed export.

Recommended implementation practices

  • Avoid excessively frequent polling.
  • Use the last status update to detect stale jobs.
  • Treat job UIDs as account-scoped identifiers.
  • Fetch one specific job when a detailed view is open.
Focused FAQ

Show all email cleaning jobs questions

Answers to common implementation, security and response-handling questions for this specific request.

Does this request return every customer's jobs?

No. Authentication scopes the response to the supplied ListCleaner account.

How do I inspect only one job?

Use the same endpoint with the uid query parameter, as described on the Show one list request page.

Can I use this endpoint for progress polling?

Yes. Use a measured polling interval and stop polling when the job reaches a final state.

Which value should I keep after upload?

Retain the UID returned by upload. It is the identifier used for status, download and deletion requests.