Get webmail information for a domain or email address

POST /public_api/v1/get_webmail_info

application/json

Body Required

email string Required

Email address or domain to lookup
skip_cache boolean

Optional flag to skip cache

Default value is false.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- success boolean
- message string
- data object
  
  Additional properties are allowed.
  
  Hide data attributes Show data attributes object
  
  name string
  
  nice_name string
  
  webmail_url string | null
  
  webmail_search_url string | null
  
  is_disposable boolean
  
  is_freemail boolean
  
  is_privacy_service boolean
400 application/json

Bad request
Hide response attributes Show response attributes object
- success boolean
- message string
- data null
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- success boolean
- message string
- data null
404 application/json

Not found
Hide response attributes Show response attributes object
- success boolean
- message string
- data null
500 application/json

Internal server error
Hide response attributes Show response attributes object
- success boolean
- message string
- data null

POST /public_api/v1/get_webmail_info

curl \
 --request POST 'https://webmaillookup.com/public_api/v1/get_webmail_info' \
 --header "Content-Type: application/json" \
 --data '{"email":"example@gmail.com"}'

Request examples

{
  "email": "example@gmail.com"
}

{
  "email": "example@gmail.com",
  "skip_cache": true
}

Response examples (200)

{
  "data": {
    "name": "Google (Public)",
    "nice_name": "Gmail",
    "is_freemail": true,
    "webmail_url": "https://mail.google.com/mail",
    "is_disposable": false,
    "is_privacy_service": false,
    "webmail_search_url": "https://mail.google.com/mail/#search/%q"
  },
  "message": "Successfully retrieved webmail info",
  "success": true
}

{
  "data": {
    "name": "Privacy Service",
    "nice_name": "Privacy Service",
    "is_freemail": false,
    "webmail_url": null,
    "is_disposable": false,
    "is_privacy_service": true,
    "webmail_search_url": null
  },
  "message": "Successfully retrieved webmail info",
  "success": true
}

Response examples (400)

{
  "data": null,
  "message": "Error parsing request - should be a json object containing the key email with an email or domain, plus an optional skip_cache argument",
  "success": false
}

Response examples (401)

{
  "data": null,
  "message": "The specified api key does not exist",
  "success": false
}

{
  "data": null,
  "message": "You don't have a valid subscription or credits to pay for this usage, please top up at https://webmaillookup.com/dashboard",
  "success": false
}

Response examples (404)

{
  "data": null,
  "message": "The specified domain does not exist or does not have MX records set",
  "success": false
}

{
  "data": null,
  "message": "Unrecognised provider",
  "success": false
}

Response examples (500)

{
  "data": null,
  "message": "An unknown error occurred whilst looking up this email",
  "success": false
}