{"info":{"_postman_id":"6103ff8b-9810-4547-990b-584e8246c124","name":"Scrubby APIs","description":" $\"\"$ \n\n

Scrubby API Documentation Overview 🚀

Welcome to the comprehensive documentation for Scrubby 🎉, your ultimate solution for email validation! Whether you're a web developer seeking API integration or a business owner looking to optimize your campaigns, Scrubby is here to empower you with accurate and real-time email validation.

🔖 Table of Contents

Introduction
Getting Started
Authentication
Endpoints
Request Formatting
Response Structure
Error Handling
Rate Limits
Community & Support

Introduction 🌟

Welcome to Scrubby's API documentation overview! With our innovative API-based email validation solution, you can seamlessly integrate our services into your applications, ensuring your campaigns are impactful and your communication channels remain robust.

Getting Started 🚀

Embark on your journey with Scrubby by following these simple steps:

Sign Up: Register for an API key (if you haven't already) to access a world of opportunities.
Authentication: Discover the seamless authentication process using unique API key to ensure secure access to your data.
Explore Endpoints: Navigate through our array of endpoints designed to cater to your technical and business needs. Explore more in the Endpoints section.

Authentication 🔒

To interact with Scrubby's API, it's essential to authenticate your requests through an API key. To acquire your API key for secure access, kindly register at app.scrubby.io. Once registered, navigate to the User Settings section and generate your unique API key. This key will serve as your secure credential for accessing the API functionalities.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Endpoints 🌐

Scrubby's API provides a range of endpoints to cater to your email validation needs. Here are some key endpoints:

POST /add_email: Validate the status of an email address.
POST /bulk_add_email: Validate a batch of email addresses in a single request.
GET /fetch_email/{email}: Retrieve your email validation result.
POST /bulk_fetch_email: Retrieve a batch of email addresses validation result.

For a complete list of endpoints and their functionalities, refer to the Examples.

Request Formatting ✨

To make successful requests to Scrubby's API, ensure you follow these formatting guidelines:

Headers: Include the x-api-key header with your API key.
Parameters: Provide the required parameters, such as the email addresses you want to validate.
Body: If necessary, include a JSON body with additional data for batch validation.

Response Structure 📦

Understand the structure of API responses to effectively process the validation results:

{\n    \"email\": \"info@scrubby.io\",\n    \"status\": \"pending\",\n    \"identifier\": \"https://webhook.scrubby.io/result\"\n}\n\n

For a complete list of response structures, refer to the Examples.

Error Handling 🔍❌

In Scrubby's API, clear and consistent error handling ensures a smooth and reliable integration experience. When making requests, our API returns distinct HTTP status codes to indicate the outcome of each operation.

200 OK: This status code indicates a successful response to your request. The request has been processed, and the API provides the expected data in the response body.
401 Unauthorized: If you receive a 401 status code, it means your request lacks proper authentication. Make sure to include your valid API key in the request headers for authorized access.
500 Internal Server Error: In the rare event of an internal server error, a 500 status code will be returned. This indicates that something unexpected happened on our end, and we're working diligently to resolve it.

Effective error handling helps ensure the stability and reliability of your interactions with Scrubby's API.

Rate Limit Usage Details ⏳

To ensure fair and equitable use of Scrubby's API resources, rate limiting is implemented. This mechanism regulates the number of requests you can make within a specific time frame, preventing excessive usage that might impact the service's performance.

Rate Limit: You are allowed to make 10 requests per second or 300 requests per minute. This means you can retrieve data or perform actions up to these limits without encountering rate limit restrictions.

If you exceed the defined rate limits, you will receive a 429 Too Many Requests status code as a response, indicating that your usage has temporarily exceeded the allowed threshold. In such cases, we recommend adhering to the rate limits and structuring your requests accordingly to ensure a seamless experience.

Proper adherence to rate limits helps maintain the stability and availability of Scrubby's API for all users.

Community & Support 👥🤝

At Scrubby, we're dedicated to providing you with the assistance you need, right when you need it. Whether you're a developer working on API integration or a business owner optimizing your campaigns, we're here to support you every step of the way through our live chat support.

Live Chat Support: For prompt and personalized assistance, visit our website app.scrubby.io and engage with our live chat support. Our team of experts is available to address your inquiries, resolve concerns, and offer guidance, ensuring a smooth and productive experience.

Technical Support: If you have specific technical queries related to Scrubby's API, you can reach out to our support team through the live chat on app.scrubby.io.

Empower yourself by engaging with the Scrubby community and tapping into our reliable support resources. Together, we can help you make the most of Scrubby's powerful email validation capabilities. 📧🚀

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Scrubby API Documentation Overview 🚀","slug":"scrubby-api-documentation-overview"}],"owner":"26586248","collectionId":"6103ff8b-9810-4547-990b-584e8246c124","publishedId":"2s9Y5SXm3H","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3CCF91"},"publishDate":"2023-08-21T01:20:11.000Z"},"item":[{"name":"Add Email","event":[{"listen":"test","script":{"id":"8477726f-4c21-4dd6-9c84-228129239e5e","exec":[""],"type":"text/javascript"}}],"id":"f473a92d-f31f-463d-851c-aa05f9954360","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@example.com\",\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}"},"url":"https://api.scrubby.io/add_email","description":"

Validate the status of an email address.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"6103ff8b-9810-4547-990b-584e8246c124","id":"6103ff8b-9810-4547-990b-584e8246c124","name":"Scrubby APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["add_email"],"host":["api","scrubby","io"],"query":[],"variable":[]}},"response":[{"id":"a9d9f74f-2ddf-4d5c-ad89-f2869f632235","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@example.com\",\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/add_email"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"abc@example.com\",\n \"status\": \"pending\",\n \"identifier\": \"identifier\"\n}"},{"id":"e5af16fc-c45c-4f7f-af0e-d8ba376303bb","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.scrubby.io/add_email","protocol":"https","host":["api","scrubby","io"],"path":["add_email"],"query":[{"key":"workspace","value":"1f0df51a-8658-4ee8-a2a1-d2567dfa09a9","description":"Optional. A workspace ID in which to create the collection.\n\nIf you do not include this query parameter, the system creates the collection in your \"My Workspace\" workspace.","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 500,\n \"message\": \"Request failed with status code 400\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"},{"id":"76ef1700-eacc-4807-80cc-c20983cff159","name":"Rate Limit Exceeded","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@example.com\",\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/add_email"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 429,\n \"message\": \"Rate limit exceeded.\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"}],"_postman_id":"f473a92d-f31f-463d-851c-aa05f9954360"},{"name":"Bulk Add Email","event":[{"listen":"test","script":{"id":"8477726f-4c21-4dd6-9c84-228129239e5e","exec":[""],"type":"text/javascript"}}],"id":"fab252dc-d0db-4382-9451-8838c2bca2c5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\"abc@example.com\", \"cde@example.com\"],\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}"},"url":"https://api.scrubby.io/bulk_add_email","description":"

Validate a batch of email addresses in a single request. You can add upto 100 emails per request.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"6103ff8b-9810-4547-990b-584e8246c124","id":"6103ff8b-9810-4547-990b-584e8246c124","name":"Scrubby APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["bulk_add_email"],"host":["api","scrubby","io"],"query":[],"variable":[]}},"response":[{"id":"d3647c16-8feb-45d0-bb3c-358929c4b00d","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@example.com\",\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/bulk_add_email"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"[\n {\n \"email\": \"abc@example.com\",\n \"status\": \"pending\",\n \"identifier\": \"identifier\"\n },\n {\n \"email\": \"cde@example.com\",\n \"status\": \"Email already added earlier.\"\n }\n]"},{"id":"7af778cf-0f45-4911-886f-14debcfe2d02","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/bulk_add_email"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 500,\n \"message\": \"Request failed with status code 400\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"},{"id":"f1022082-3ad3-4044-949a-89ce89650469","name":"Rate Limit Exceeded","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@example.com\",\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/bulk_add_email"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 429,\n \"message\": \"Rate limit exceeded.\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"}],"_postman_id":"fab252dc-d0db-4382-9451-8838c2bca2c5"},{"name":"Fetch Email","event":[{"listen":"test","script":{"id":"8477726f-4c21-4dd6-9c84-228129239e5e","exec":[""],"type":"text/javascript"}}],"id":"9740c24c-f66f-47a9-ba05-167afa1a948b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.scrubby.io/fetch_email/{{email}}","description":"

Validate the status of an email address.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"6103ff8b-9810-4547-990b-584e8246c124","id":"6103ff8b-9810-4547-990b-584e8246c124","name":"Scrubby APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["fetch_email","{{email}}"],"host":["api","scrubby","io"],"query":[],"variable":[]}},"response":[{"id":"e6bd7129-ee5d-49b5-b63d-0341de99ccaa","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"url":"https://api.scrubby.io/fetch_email/{{email}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"email\": {{email}},\n \"status\": \"Valid\",\n \"identifier\": \"identifier\"\n}"},{"id":"de2f6cd1-1b8f-4bd9-ac0e-8c304d05cea3","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"x-api-key","type":"text"}],"url":"https://api.scrubby.io/fetch_email/{{email}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 500,\n \"message\": \"Request failed with status code 400\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"},{"id":"520ff4b6-52a6-4e9b-aba3-76458235b6ef","name":"Rate Limit Exceeded","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"url":"https://api.scrubby.io/fetch_email/{{email}}"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 429,\n \"message\": \"Rate limit exceeded.\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"}],"_postman_id":"9740c24c-f66f-47a9-ba05-167afa1a948b"},{"name":"Bulk Fetch Emails","event":[{"listen":"test","script":{"id":"8477726f-4c21-4dd6-9c84-228129239e5e","exec":[""],"type":"text/javascript"}}],"id":"588300c3-e2cc-4146-bf50-3898c131f4fa","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\"abc@example.com\", \"cde@example.com\"]\n}"},"url":"https://api.scrubby.io/bulk_fetch_email","description":"

Validate a batch of email addresses in a single request. You can add upto 100 emails per request.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"6103ff8b-9810-4547-990b-584e8246c124","id":"6103ff8b-9810-4547-990b-584e8246c124","name":"Scrubby APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["bulk_fetch_email"],"host":["api","scrubby","io"],"query":[],"variable":[]}},"response":[{"id":"1411f8fd-1d8d-44b8-8b5d-91d074fd8f3f","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\"abc@example.com\", \"cde@example.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/bulk_fetch_email"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"[\n {\n \"email\": \"abc@example.com\",\n \"status\": \"pending\",\n \"identifier\": \"identifier\"\n },\n {\n \"email\": \"cde@example.com\",\n \"status\": \"Valid\",\n \"identifier\": \"identifier\"\n }\n]"},{"id":"f0ba1cb1-2fe9-4cd2-aa35-5c64e5962b27","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": [\"abc@example.com\", \"cde@example.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/bulk_fetch_email"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 500,\n \"message\": \"Request failed with status code 400\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"},{"id":"01912e26-b90d-441b-a0ed-9bcec3eb9738","name":"Rate Limit Exceeded","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"abc@example.com\",\n \"callback_url\": \"https://webhook.com/fetch\",\n \"identifier\": \"identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.scrubby.io/bulk_fetch_email"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 429,\n \"message\": \"Rate limit exceeded.\",\n \"id\": \"err_jYeN2FS1UTnnOdvjL0kM\"\n}"}],"_postman_id":"588300c3-e2cc-4146-bf50-3898c131f4fa"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api-key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"92c22020-606e-47f9-9709-547602852272","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c684e2c0-c47b-40f7-b529-874af1cce6a4","type":"text/javascript","exec":[""]}}],"variable":[{"key":"api-key","value":"ak_wP1h79CaljQKkyLfffIh","disabled":true},{"key":"email","value":"saket.tiwari@vendisys.com","disabled":true}]}