Get Webmail Info

POST /public_api/v1/get_webmail_info

application/json

Body Required

V1GetWebmailInfoRequest

email string(email) Required

Email or domain to retrieve webmail info for
skip_cache boolean

Optional flag to skip cache. Request consumes 2 credits instead of 1.

Responses

200 application/json

Successfully retrieved webmail info
Hide response attributes Show response attributes object
- success boolean
  
  Indicates if the request was successful
- message string
  
  Response message
- data object
  
  Hide data attributes Show data attributes object
  
  name string
  
  The name of the webmail provider
  
  nice_name string
  
  The nice name of the webmail provider
  
  webmail_url string
  
  The URL of the webmail
  
  webmail_search_url string | null
  
  The search URL of the webmail
  
  is_disposable boolean
  
  Whether the service offers disposable/temporary email addresses
  
  Default value is false.
400 application/json

Error parsing request
Hide response attributes Show response attributes object
- success boolean
  
  Indicates if the request was successful
- message string
  
  Response message
- data null
401 application/json

Unauthorized (API Key not found)
Hide response attributes Show response attributes object
- success boolean
  
  Indicates if the request was successful
- message string
  
  Response message
- data null
402 application/json

Payment Required (Out of API Credits)
Hide response attributes Show response attributes object
- success boolean
  
  Indicates if the request was successful
- message string
  
  Response message
- data null
404 application/json

Not Found (Service Unknown or No Email on that Domain)
Hide response attributes Show response attributes object
- success boolean
  
  Indicates if the request was successful
- message string
  
  Response message
- data null
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- success boolean
  
  Indicates if the request was successful
- message string
  
  Response message
- data null

POST /public_api/v1/get_webmail_info

curl \
 -X POST https://webmaillookup.com/public_api/v1/get_webmail_info \
 -H "Content-Type: application/json" \
 -d '{"email":"hello@example.com","skip_cache":true}'

Request examples

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

Response examples (200)

{
  "success": true,
  "message": "Successfully retrieved webmail info",
  "data": {
    "name": "Google Mail",
    "nice_name": "Gmail",
    "webmail_url": "https://mail.google.com/mail",
    "webmail_search_url": "string",
    "is_disposable": false
  }
}

Response examples (400)

{
  "success": false,
  "message": "The authorization header must be in the form: Bearer api_key (where api_key is the key from your dashboard)",
  "data": null
}

Response examples (401)

{
  "success": false,
  "message": "The authorization header must be in the form: Bearer api_key (where api_key is the key from your dashboard)",
  "data": null
}

Response examples (402)

{
  "success": false,
  "message": "The authorization header must be in the form: Bearer api_key (where api_key is the key from your dashboard)",
  "data": null
}

Response examples (404)

{
  "success": false,
  "message": "The authorization header must be in the form: Bearer api_key (where api_key is the key from your dashboard)",
  "data": null
}

Response examples (500)

{
  "success": false,
  "message": "The authorization header must be in the form: Bearer api_key (where api_key is the key from your dashboard)",
  "data": null
}