Skip to main content
GET
/
v1
/
api
/
cleanedemail
View Clean List Results
curl --request GET \
  --url https://base.sanitizeemail.com/v1/api/cleanedemail/ \
  --header 'X-API-KEY: <api-key>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 123,
      "workspace": {
        "id": 123,
        "name": "<string>",
        "owner": 123
      },
      "clean_email": {
        "id": 123,
        "file_id": {
          "id": 123,
          "name": "<string>",
          "file_name": "<string>",
          "status": "<string>",
          "clean_email_count": 123,
          "bounce_rate": 123
        }
      },
      "valid_email": "[email protected]",
      "created_date": "2023-11-07T05:31:56Z"
    }
  ]
}
This endpoint retrieves the results of a cleaned email list, showing all valid emails that passed the validation process. Use this to access the clean emails after the cleaning job is completed.

​
How it Works

1

Complete Email Cleaning

First use the Clean Email List endpoint to process your file
2

Check Processing Status

Monitor the cleaning progress using the View File endpoint
3

Retrieve Clean Results

Once status is “cleaned”, use this endpoint to get the valid emails
4

Handle Pagination

Navigate through results using the pagination parameters

​
When to Use This Endpoint

After Cleaning Complete

Retrieve results only after the file status shows “cleaned”

Access Valid Emails

Get the list of emails that passed all validation checks

Download Clean Data

Access validated emails for your marketing campaigns

Review Cleaning Results

Examine the quality and quantity of your clean email list

​
Example Usage

curl -X GET "https://base.sanitizeemail.com/v1/api/cleanedemail/?file_id=757&size=20&page=1" \
  -H "X-API-KEY: YOUR_API_KEY"

​
Response Format

​
Successful Response (With Results)

{
  "count": 168,
  "next": "https://base.sanitizeemail.com/v1/api/cleanedemail/?file_id=757&page=2&size=20",
  "previous": null,
  "results": [
    {
      "id": 3796123,
      "workspace": {
        "id": 100,
        "name": "asim's Team",
        "owner": 100
      },
      "clean_email": {
        "id": 188,
        "file_id": {
          "id": 757,
          "name": "Structured cleaned",
          "file_name": "Marketing Agency Australia.xlsx",
          "status": "cleaned",
          "clean_email_count": 173,
          "bounce_rate": 0
        }
      },
      "valid_email": "[email protected]",
      "created_date": "2025-07-14T15:41:41.921862+05:45"
    }
  ]
}

​
Empty Response (No Clean Results)

{
  "count": 0,
  "next": null,
  "previous": null,
  "results": []
}

​
Understanding Empty Results

Empty Results: If the response contains no results, check the file processing status using the View File endpoint to determine the cause:
File StatusMeaningAction Required
processingCleaning in progressWait for completion
cleanedCleaning complete, no valid emailsAll emails were invalid
failedProcessing failedCheck error logs or retry

​
Important Notes

File ID Required: The file_id parameter is mandatory. You can only retrieve results for files you have uploaded and processed.
Check Status First: Always verify the file status is “cleaned” using the View File endpoint before expecting results.

Pagination

Large Result Sets: Use size and page parameters to navigate through large numbers of clean emails efficiently.

​
Common Scenarios

​
Scenario 1: Processing Still in Progress

// File status check shows:
{
  "status": "processing",
  "progress_percentage": 75
}
// Clean results will be empty until processing completes

​
Scenario 2: All Emails Invalid

// File status shows:
{
  "status": "cleaned",
  "clean_email_count": 0,
  "invalid_emails_count": 150
}
// Clean results will be empty because no emails passed validation

​
Scenario 3: Successful Cleaning

// File status shows:
{
  "status": "cleaned",
  "clean_email_count": 173,
  "bounce_rate": 0
}
// Clean results will contain the valid emails

​
Error Responses

Status CodeDescriptionAction
400Invalid file_id or missing parameterCheck the file_id value
401Unauthorized accessVerify your API key
404File not foundEnsure file exists and belongs to you

​
Prerequisites

Required Steps: 1. Upload file using File Upload 2. Clean file using Clean Email List 3. Wait for processing to complete 4. Retrieve results with this endpoint

Authorizations

​
X-API-KEY
string
header
required

API key for authentication

Query Parameters

​
file_id
integer

The ID of the file for which to retrieve results.

​
size
integer
default:10

Number of results to return per page.

Required range: 1 <= x <= 100
​
page
integer
default:1

Page number for pagination.

Required range: x >= 1

Response

Successful retrieval of cleaned email list.

​
count
integer

Total number of cleaned emails

​
next
string<uri> | null

URL for the next page of results

​
previous
string<uri> | null

URL for the previous page of results

​
results
object[]

Array of cleaned email objects