{
  "service": "icypeas",
  "displayName": "Icypeas",
  "categories": [
    "Data",
    "Marketing"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "API Key",
      "placeholder": "ICYPEAS_API_KEY",
      "description": "Icypeas API key sent directly in the Authorization header. Enable API access and copy the key from the API section of your Icypeas profile: https://api-doc.icypeas.com/api-auth/access-keys."
    }
  ],
  "homepageUrl": "https://www.icypeas.com",
  "actions": [
    {
      "id": "icypeas.get_search_item",
      "service": "icypeas",
      "name": "get_search_item",
      "description": "Retrieve one Icypeas search item by ID and expose its processing status.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "The Icypeas search item ID returned by a submit action."
          }
        },
        "additionalProperties": false,
        "description": "Input for retrieving one Icypeas search item."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Whether Icypeas accepted the result lookup."
          },
          "item": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "_id": {
                    "type": "string",
                    "description": "The Icypeas search item ID."
                  },
                  "status": {
                    "type": "string",
                    "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
                  },
                  "name": {
                    "type": "string",
                    "description": "The search item name returned by Icypeas."
                  },
                  "file": {
                    "type": "string",
                    "description": "The bulk file ID associated with the item, when present."
                  },
                  "order": {
                    "type": "integer",
                    "description": "The item order inside a bulk search, when present."
                  },
                  "results": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "userData": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "system": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  }
                },
                "additionalProperties": true,
                "description": "An Icypeas search item result."
              },
              {
                "type": "null"
              }
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "The Icypeas search item ID."
                },
                "status": {
                  "type": "string",
                  "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
                },
                "name": {
                  "type": "string",
                  "description": "The search item name returned by Icypeas."
                },
                "file": {
                  "type": "string",
                  "description": "The bulk file ID associated with the item, when present."
                },
                "order": {
                  "type": "integer",
                  "description": "The item order inside a bulk search, when present."
                },
                "results": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": true,
                  "description": "A raw object returned by Icypeas."
                },
                "userData": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": true,
                  "description": "A raw object returned by Icypeas."
                },
                "system": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": true,
                  "description": "A raw object returned by Icypeas."
                }
              },
              "additionalProperties": true,
              "description": "An Icypeas search item result."
            },
            "description": "Search items returned by Icypeas."
          },
          "status": {
            "anyOf": [
              {
                "type": "string",
                "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
              },
              {
                "type": "null"
              }
            ]
          },
          "total": {
            "anyOf": [
              {
                "type": "integer",
                "description": "The total number of matching search items."
              },
              {
                "type": "null"
              }
            ]
          },
          "sorts": {
            "type": "array",
            "items": {
              "description": "One sort tuple."
            },
            "description": "Pagination cursor tuples returned by Icypeas."
          },
          "validationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "expected": {
                  "description": "The expected value or type for the invalid field."
                },
                "actual": {
                  "description": "The actual value that Icypeas received for the invalid field."
                },
                "type": {
                  "type": "string",
                  "description": "The Icypeas validation error type."
                },
                "field": {
                  "type": "string",
                  "description": "The field that caused the validation error."
                },
                "message": {
                  "type": "string",
                  "description": "The machine-readable validation error message."
                }
              },
              "additionalProperties": true,
              "description": "A validation error returned by Icypeas."
            },
            "description": "Validation errors returned by Icypeas."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A raw object returned by Icypeas."
          }
        },
        "additionalProperties": false,
        "description": "The normalized Icypeas search item response."
      }
    },
    {
      "id": "icypeas.get_subscription_information",
      "service": "icypeas",
      "name": "get_subscription_information",
      "description": "Fetch Icypeas subscription details and remaining credit balances by account email.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "The email address of the Icypeas account owner.",
            "format": "email"
          }
        },
        "additionalProperties": false,
        "description": "Input for fetching Icypeas subscription information."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "subscription": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A raw object returned by Icypeas."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A raw object returned by Icypeas."
          }
        },
        "additionalProperties": false,
        "description": "The normalized Icypeas subscription information response."
      }
    },
    {
      "id": "icypeas.reverse_email_lookup",
      "service": "icypeas",
      "name": "reverse_email_lookup",
      "description": "Find a LinkedIn profile URL behind one professional email address with Icypeas.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "The professional email address to look up.",
            "format": "email"
          }
        },
        "additionalProperties": false,
        "description": "Input for an Icypeas reverse email lookup."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Whether Icypeas processed the reverse email lookup request."
          },
          "searchId": {
            "anyOf": [
              {
                "type": "string",
                "description": "The Icypeas search item ID for this reverse lookup."
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "anyOf": [
              {
                "type": "string",
                "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
              },
              {
                "type": "null"
              }
            ]
          },
          "result": {
            "anyOf": [
              {
                "type": "string",
                "description": "The LinkedIn profile URL returned by Icypeas, or an empty string when not found."
              },
              {
                "type": "null"
              }
            ]
          },
          "validationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "expected": {
                  "description": "The expected value or type for the invalid field."
                },
                "actual": {
                  "description": "The actual value that Icypeas received for the invalid field."
                },
                "type": {
                  "type": "string",
                  "description": "The Icypeas validation error type."
                },
                "field": {
                  "type": "string",
                  "description": "The field that caused the validation error."
                },
                "message": {
                  "type": "string",
                  "description": "The machine-readable validation error message."
                }
              },
              "additionalProperties": true,
              "description": "A validation error returned by Icypeas."
            },
            "description": "Validation errors returned by Icypeas."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A raw object returned by Icypeas."
          }
        },
        "additionalProperties": false,
        "required": [
          "success",
          "searchId",
          "status",
          "result",
          "raw"
        ],
        "description": "The normalized Icypeas reverse email lookup response."
      }
    },
    {
      "id": "icypeas.submit_domain_scan",
      "service": "icypeas",
      "name": "submit_domain_scan",
      "description": "Submit one Icypeas domain scan for role-based email addresses.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "domainOrCompany": {
            "type": "string",
            "minLength": 1,
            "description": "The domain or company name to scan."
          },
          "custom": {
            "type": "object",
            "properties": {
              "webhookUrl": {
                "type": "string",
                "description": "A webhook URL that Icypeas should call when this search finishes.",
                "format": "uri"
              },
              "externalId": {
                "type": "string",
                "minLength": 1,
                "description": "A custom ID that Icypeas stores with this search item."
              }
            },
            "additionalProperties": false,
            "description": "Optional custom tracking data attached to one Icypeas single search."
          }
        },
        "additionalProperties": false,
        "required": [
          "domainOrCompany"
        ],
        "description": "Input for submitting one Icypeas domain scan."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Whether Icypeas accepted the request."
          },
          "searchId": {
            "anyOf": [
              {
                "type": "string",
                "description": "The created Icypeas search item ID."
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "anyOf": [
              {
                "type": "string",
                "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
              },
              {
                "type": "null"
              }
            ]
          },
          "item": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "_id": {
                    "type": "string",
                    "description": "The Icypeas search item ID."
                  },
                  "status": {
                    "type": "string",
                    "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
                  },
                  "name": {
                    "type": "string",
                    "description": "The search item name returned by Icypeas."
                  },
                  "file": {
                    "type": "string",
                    "description": "The bulk file ID associated with the item, when present."
                  },
                  "order": {
                    "type": "integer",
                    "description": "The item order inside a bulk search, when present."
                  },
                  "results": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "userData": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "system": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  }
                },
                "additionalProperties": true,
                "description": "An Icypeas search item result."
              },
              {
                "type": "null"
              }
            ]
          },
          "validationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "expected": {
                  "description": "The expected value or type for the invalid field."
                },
                "actual": {
                  "description": "The actual value that Icypeas received for the invalid field."
                },
                "type": {
                  "type": "string",
                  "description": "The Icypeas validation error type."
                },
                "field": {
                  "type": "string",
                  "description": "The field that caused the validation error."
                },
                "message": {
                  "type": "string",
                  "description": "The machine-readable validation error message."
                }
              },
              "additionalProperties": true,
              "description": "A validation error returned by Icypeas."
            },
            "description": "Validation errors returned by Icypeas."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A raw object returned by Icypeas."
          }
        },
        "additionalProperties": false,
        "required": [
          "success",
          "searchId",
          "status",
          "item",
          "raw"
        ],
        "description": "The normalized Icypeas single-search submission response."
      },
      "followUpActions": [
        "icypeas.get_search_item"
      ],
      "asyncLifecycle": {
        "startActionId": "icypeas.submit_domain_scan",
        "statusActionId": "icypeas.get_search_item"
      }
    },
    {
      "id": "icypeas.submit_email_search",
      "service": "icypeas",
      "name": "submit_email_search",
      "description": "Submit one Icypeas email discovery search for a person and company.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "firstname": {
            "type": "string",
            "minLength": 1,
            "description": "The person's first name. Required when lastname is omitted."
          },
          "lastname": {
            "type": "string",
            "minLength": 1,
            "description": "The person's last name. Required when firstname is omitted."
          },
          "domainOrCompany": {
            "type": "string",
            "minLength": 1,
            "description": "The person's company domain or company name."
          },
          "custom": {
            "type": "object",
            "properties": {
              "webhookUrl": {
                "type": "string",
                "description": "A webhook URL that Icypeas should call when this search finishes.",
                "format": "uri"
              },
              "externalId": {
                "type": "string",
                "minLength": 1,
                "description": "A custom ID that Icypeas stores with this search item."
              }
            },
            "additionalProperties": false,
            "description": "Optional custom tracking data attached to one Icypeas single search."
          }
        },
        "additionalProperties": false,
        "required": [
          "domainOrCompany"
        ],
        "description": "Input for submitting one Icypeas email discovery search.",
        "anyOf": [
          {
            "required": [
              "firstname"
            ]
          },
          {
            "required": [
              "lastname"
            ]
          }
        ]
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Whether Icypeas accepted the request."
          },
          "searchId": {
            "anyOf": [
              {
                "type": "string",
                "description": "The created Icypeas search item ID."
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "anyOf": [
              {
                "type": "string",
                "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
              },
              {
                "type": "null"
              }
            ]
          },
          "item": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "_id": {
                    "type": "string",
                    "description": "The Icypeas search item ID."
                  },
                  "status": {
                    "type": "string",
                    "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
                  },
                  "name": {
                    "type": "string",
                    "description": "The search item name returned by Icypeas."
                  },
                  "file": {
                    "type": "string",
                    "description": "The bulk file ID associated with the item, when present."
                  },
                  "order": {
                    "type": "integer",
                    "description": "The item order inside a bulk search, when present."
                  },
                  "results": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "userData": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "system": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  }
                },
                "additionalProperties": true,
                "description": "An Icypeas search item result."
              },
              {
                "type": "null"
              }
            ]
          },
          "validationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "expected": {
                  "description": "The expected value or type for the invalid field."
                },
                "actual": {
                  "description": "The actual value that Icypeas received for the invalid field."
                },
                "type": {
                  "type": "string",
                  "description": "The Icypeas validation error type."
                },
                "field": {
                  "type": "string",
                  "description": "The field that caused the validation error."
                },
                "message": {
                  "type": "string",
                  "description": "The machine-readable validation error message."
                }
              },
              "additionalProperties": true,
              "description": "A validation error returned by Icypeas."
            },
            "description": "Validation errors returned by Icypeas."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A raw object returned by Icypeas."
          }
        },
        "additionalProperties": false,
        "required": [
          "success",
          "searchId",
          "status",
          "item",
          "raw"
        ],
        "description": "The normalized Icypeas single-search submission response."
      },
      "followUpActions": [
        "icypeas.get_search_item"
      ],
      "asyncLifecycle": {
        "startActionId": "icypeas.submit_email_search",
        "statusActionId": "icypeas.get_search_item"
      }
    },
    {
      "id": "icypeas.submit_email_verification",
      "service": "icypeas",
      "name": "submit_email_verification",
      "description": "Submit one Icypeas email verification request and return the search item handle.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "The email address to verify.",
            "format": "email"
          },
          "custom": {
            "type": "object",
            "properties": {
              "webhookUrl": {
                "type": "string",
                "description": "A webhook URL that Icypeas should call when this search finishes.",
                "format": "uri"
              },
              "externalId": {
                "type": "string",
                "minLength": 1,
                "description": "A custom ID that Icypeas stores with this search item."
              }
            },
            "additionalProperties": false,
            "description": "Optional custom tracking data attached to one Icypeas single search."
          }
        },
        "additionalProperties": false,
        "required": [
          "email"
        ],
        "description": "Input for submitting one Icypeas email verification request."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Whether Icypeas accepted the request."
          },
          "searchId": {
            "anyOf": [
              {
                "type": "string",
                "description": "The created Icypeas search item ID."
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "anyOf": [
              {
                "type": "string",
                "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
              },
              {
                "type": "null"
              }
            ]
          },
          "item": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "_id": {
                    "type": "string",
                    "description": "The Icypeas search item ID."
                  },
                  "status": {
                    "type": "string",
                    "description": "The Icypeas search item processing status, such as NONE, IN_PROGRESS, FOUND, or DEBITED."
                  },
                  "name": {
                    "type": "string",
                    "description": "The search item name returned by Icypeas."
                  },
                  "file": {
                    "type": "string",
                    "description": "The bulk file ID associated with the item, when present."
                  },
                  "order": {
                    "type": "integer",
                    "description": "The item order inside a bulk search, when present."
                  },
                  "results": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "userData": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  },
                  "system": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "A raw object returned by Icypeas."
                  }
                },
                "additionalProperties": true,
                "description": "An Icypeas search item result."
              },
              {
                "type": "null"
              }
            ]
          },
          "validationErrors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "expected": {
                  "description": "The expected value or type for the invalid field."
                },
                "actual": {
                  "description": "The actual value that Icypeas received for the invalid field."
                },
                "type": {
                  "type": "string",
                  "description": "The Icypeas validation error type."
                },
                "field": {
                  "type": "string",
                  "description": "The field that caused the validation error."
                },
                "message": {
                  "type": "string",
                  "description": "The machine-readable validation error message."
                }
              },
              "additionalProperties": true,
              "description": "A validation error returned by Icypeas."
            },
            "description": "Validation errors returned by Icypeas."
          },
          "raw": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "A raw object returned by Icypeas."
          }
        },
        "additionalProperties": false,
        "required": [
          "success",
          "searchId",
          "status",
          "item",
          "raw"
        ],
        "description": "The normalized Icypeas single-search submission response."
      },
      "followUpActions": [
        "icypeas.get_search_item"
      ],
      "asyncLifecycle": {
        "startActionId": "icypeas.submit_email_verification",
        "statusActionId": "icypeas.get_search_item"
      }
    }
  ]
}