Webmail Info API - API Documentation

Overview

Welcome to the Webmail Info API documentation.

Base URL

https://webmaillookup.com

Authentication

bearerAuth

Type: http | Scheme: bearer

POST /public_api/v1/get_webmail_info

Get webmail information for a domain or email address

Authentication required: bearerAuth

Request Body

Schema:

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Email address or domain to lookup"
    },
    "skip_cache": {
      "type": "boolean",
      "description": "Optional flag to skip cache",
      "default": false
    }
  },
  "required": [
    "email"
  ]
}

Examples:

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

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

Responses

500 Internal server error

Schema:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "null"
    },
    "message": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    }
  }
}

Examples:

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

200 Successful response

Schema:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object"
    },
    "message": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    }
  }
}

Examples:

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

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

400 Bad request

Schema:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "null"
    },
    "message": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    }
  }
}

Examples:

{
  "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
}

401 Unauthorized

Schema:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "null"
    },
    "message": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    }
  }
}

Examples:

{
  "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
}

404 Not found

Schema:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "null"
    },
    "message": {
      "type": "string"
    },
    "success": {
      "type": "boolean"
    }
  }
}

Examples:

{
  "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
}