lists

Get the all list info

get/lists/

Request

  • Base URL: https://api.listclean.xyz/v1
  • URL: https://api.listclean.xyz/v1/lists/
  • Auth: API key in header X-Auth-Token

Response

Response on success

success0 | 1

Success status, 0 for failed 1 for success

messagestring
error_codeinteger

Example response

{
  "success": 1,
  "message": "List info successfully extracted",
  "data": {
    "total": 7,
    "cursor": 1,
    "lists": [
      {
        "list_id": 1,
        "filename": "sample-list.csv",
        "size_in_bytes": 229,
        "request_time": "2021-11-06 22:37:19",
        "status": "COMPLETED",
        "upload_id": "Q1636218416-991025",
        "analytics": {
          "summary": {
            "total": 12,
            "duplicate": 1
          },
          "dirty_summary": [
            {
              "dirty_type": "Disposable Email"
            }
          ],
          "clean_summary": [
            {
              "clean_type": "High Quality"
            }
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.