Skip to main content
Icypeas logo

Overview

Add Icypeas to any ModuleX agent or workflow. Find and verify professional email addresses against the Icypeas REST API (app.icypeas.com). Resolve a likely professional email from a person’s name and company domain, or check whether an existing address is valid and deliverable. Both operations run asynchronously: a job is submitted, then the result is fetched by polling.
Categories: Sales · Enrichment · Sales Engagement · Auth: API Key · Actions: 2

Authentication

API Key Authentication

Authenticate using your Icypeas API key
1

Step 1

Go to https://app.icypeas.com and sign up or log in
2

Step 2

Open the API settings / API access section in your account
3

Step 3

Create a new API key or copy your existing one
4

Step 4

Paste the API key below

Required Credentials

FieldDescriptionRequiredFormat
Icypeas API KeyYour Icypeas API key from app.icypeas.comYes-

Available Actions

Parameters

domain_or_company
string
required
Target company domain (e.g. stripe.com) or company name (e.g. Stripe)
firstname
string
Target person’s first name
lastname
string
Target person’s last name

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "search_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Search Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Email"
    },
    "firstname": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Firstname"
    },
    "lastname": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Lastname"
    },
    "item": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Item"
    }
  },
  "required": [
    "success"
  ],
  "title": "FindEmailOutput",
  "type": "object"
}

Parameters

email
string
required
Email address to verify (e.g. john@stripe.com)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "search_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Search Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Email"
    },
    "valid": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Valid"
    },
    "item": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Item"
    }
  },
  "required": [
    "success"
  ],
  "title": "VerifyEmailOutput",
  "type": "object"
}

Limits & Quotas

  • Async polling: each call submits a job, then polls the read endpoint roughly every 3 seconds for up to 120 seconds. If the job does not reach a terminal status in that window, the call returns success=False with an explanatory error.
  • Terminal statuses: FOUND, DEBITED, NOT_FOUND, DEBITED_NOT_FOUND, BAD_INPUT, INSUFFICIENT_FUNDS, ABORTED. A clean no-match (NOT_FOUND) is still a successful run — email is simply null and, for verification, valid is false.
  • Rate limits: approximately 60 requests/minute.
  • Pricing (approx., per vendor pricing page): email finding ~1 credit per found email; email verification ~0.1 credit per check.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising. Plan for retries on the agent side based on the error string.

Enrow

Findymail

NeverBounce