« Back to Documentation Overview

get_account_blacklist

Section: Blacklists
Version: 1.5.0


Get blacklist masks on account level.
Conditions:

  • mask (optional) – Use text operators to narrow down search results to specific masks.
  • created_on (optional) – Use time operators to narrow down search results to specific mask creation date. Multiple operators are allowed and logic AND is used so date range can also be expressed.

Format of mask can be:
  • whole email – xxx@yyy.zz
  • local part of email- xxx@
  • host part of email – @yyy.zz
  • MD5 hash of email – d6dba89e8479a7049d2d7b2e5b6528ec
  • ISP name – #yahoo (note the # on the beginning)
  • IP address – 1.2.33.44 (IPv4 format only)

Warning: According to this FAQ MD5 hash should be generated from lowercased email, check “Why do I have to normalize email addresses prior to encrypting?” section.


Parameters
stringAPI_KEY
object
objectmask
stringOPERATORvalue
objectcreated_on
stringOPERATORvalue
Return Value
stringmy_contact_1@emailaddress.com2010-01-01 00:00:00
stringmy_contact_2@emailaddress.com2010-01-01 00:00:00

Example Request JSON

[
    "API_KEY",
    {
        "mask": {
            "OPERATOR": "value"
        },
        "created_on": {
            "OPERATOR": "value"
        }
    }
]

Example Response JSON

{
    "my_contact_1@emailaddress.com": "2010-01-01 00:00:00",
    "my_contact_2@emailaddress.com": "2010-01-01 00:00:00"
}
API-wide Errors
API key verification failed API key verification failed
API client IP not allowed API client IP not allowed
Invalid params Attribute params must be reference to hash