API Reference

The Outscaler API allows you to programmatically manage tasks, verify emails in bulk, and find work emails. It is built around REST and utilizes predictable resource-oriented URLs.

Authentication

All requests to the Outscaler API must be authenticated. You can manage your API keys in the developer dashboard. Pass your active API key as a token in the Authorization header.

Authorization: <YOUR_API_KEY>

Verify a single email

Verify an email.

POST/public/verifier/verify

Parameters

  • emailstringRequiredbody

    The email address to verify.

cURL
curl -X POST https://api.outscaler.in/public/verifier/verify \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"test@example.com"}'

Find a work email

Find work email. Returns all valid emails.

POST/public/finder/work-email

Parameters

  • firstNamestringRequiredbody

    The first name of the person.

  • lastNamestringRequiredbody

    The last name of the person.

  • domainstringRequiredbody

    The company domain (e.g. outscalar.com).

cURL
curl -X POST https://api.outscaler.in/public/finder/work-email \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"John", "lastName":"Doe", "domain":"outscalar.com"}'

Upload CSV for bulk email verification

Upload a CSV file and specify column mappings to bulk verify emails using credits associated with the api key. Requires multipart/form-data content type.

POST/public/tasks/verify-email-bulk

Parameters

  • titlestringbody

    The title of the bulk verification task (e.g. "My Email List").

  • mappingstringRequiredbody

    A JSON string representing the CSV column mapping (e.g. {"email": "my_email_column"}).

  • csvFilebinaryRequiredbody

    The CSV file containing emails to verify.

cURL
curl -X POST https://api.outscaler.in/public/tasks/verify-email-bulk \
  -H "Authorization: YOUR_API_KEY" \
  -F "title=My Email List" \
  -F "mapping={\"email\": \"email_col\"}" \
  -F "csvFile=@/path/to/your/file.csv"

Get task status

Fetch the status of a bulk processing task by its public ID. Returns "pending", "processing", "completed", or "failed".

GET/public/tasks/status/{publicUid}

Parameters

  • publicUidstringRequiredpath

    The unique public ID returned when you uploaded the task.

cURL
curl -X GET "https://api.outscaler.in/public/tasks/status/YOUR_PUBLIC_UID" \
  -H "Authorization: YOUR_API_KEY"

Download verification task results

Download the results of an email verification task as a CSV. Returns a 400 error if the task is not yet completed.

GET/public/tasks/bulk-verifier-result/{publicUid}

Parameters

  • publicUidstringRequiredpath

    The unique public ID of the completed verification task.

cURL
curl -X GET "https://api.outscaler.in/public/tasks/bulk-verifier-result/YOUR_PUBLIC_UID" \
  -H "Authorization: YOUR_API_KEY" \
  -o result.csv

Upload CSV for bulk work email finding

Upload a CSV file and map columns to find work emails. Requires multipart/form-data. Requires firstName, lastName, and domain mapping.

POST/public/tasks/find-work-email-bulk

Parameters

  • titlestringbody

    The title of the task (e.g. "Find Emails for Tech Leads").

  • typestringRequiredbody

    The type of the task. Should be "bulk_work_email" for this endpoint.

  • mappingstringRequiredbody

    A JSON string representing the CSV column mapping (e.g. {"firstName": "f_name", "lastName": "l_name", "companyDomain": "domain"}).

  • csvFilebinaryRequiredbody

    The CSV file containing data.

cURL
curl -X POST https://api.outscaler.in/public/tasks/find-work-email-bulk \
  -H "Authorization: YOUR_API_KEY" \
  -F "title=Find Emails for Tech Leads" \
  -F "type=bulk_work_email" \
  -F "mapping={\"firstName\": \"first_name\", \"lastName\": \"last_name\", \"companyDomain\": \"domain\"}" \
  -F "csvFile=@/path/to/your/leads.csv"

Download work email task results

Download the results of a work email finding task as a CSV. Returns a 400 error if the task is not yet completed.

GET/public/tasks/bulk-work-email-result/{publicUid}

Parameters

  • publicUidstringRequiredpath

    The unique public ID of the completed work email finding task.

cURL
curl -X GET "https://api.outscaler.in/public/tasks/bulk-work-email-result/YOUR_PUBLIC_UID" \
  -H "Authorization: YOUR_API_KEY" \
  -o leads_result.csv