GET /listcleaning/list/{id}

GET 
listcleaning/list/:id

Retrieve a list cleaning job by its ID

Path Parameters

id string Required

Returns

• dataobject
  • idstring
    Unique identifier of the listcleaning list
  • titlestring
    Name of the listcleaning list for easy identification
  • profile_idstring
    Profile ID associated with the list
  • webhook_urlstring
    Webhook URL to receive list processing status updates
  • statusstring
    Current processing status of the listcleaning list
    Allowed values: INIT, PRE_PROCESSING, PRE_PROCESSING_DONE, PROCESSING, DONE, FAILED
  • available_presaved_listsarray
    List of available presaved result variants that can be downloaded
    Allowed values: all, safe-to-send, send-with-caution
  • emails_countnumber
    Total number of emails in the list
  • invalid_format_countnumber
    Number of emails with invalid email format
  • duplicates_countnumber
    Number of duplicate emails found in the list
  • domains_countnumber
    Total number of unique domains in the list
  • created_atstring
    Timestamp when the list was created
  • updated_atstring
    Timestamp when the list was last updated
  • processing_start_atstring
    Timestamp when the list processing started
  • processing_end_atstring
    Timestamp when the list processing completed
  • preprocessing_errorstring
    Error message if preprocessing failed
  • processing_errorstring
    Error message if processing failed
  • listcleaning_resultsobject
    Summary of listcleaning results with counts for each category
    • countnumber
      Total number of processed emails
    • deliverablenumber
      Number of emails with deliverable status
    • riskynumber
      Number of emails with risky status
    • undeliverablenumber
      Number of emails with undeliverable status
    • unknownnumber
      Number of emails with unknown status
    • toxicity_0number
      Number of emails with toxicity level 0 (lowest)
    • toxicity_1number
      Number of emails with toxicity level 1
    • toxicity_2number
      Number of emails with toxicity level 2
    • toxicity_3number
      Number of emails with toxicity level 3
    • toxicity_4number
      Number of emails with toxicity level 4
    • toxicity_5number
      Number of emails with toxicity level 5 (highest)

Error Codes

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Internal server error