{
  "url": "https://telipot.com/catalog/tasks/hunter.email.domain.count",
  "id": "hunter.email.domain.count",
  "name": "Count of emails on file for a domain, by type and department",
  "provider": {
    "slug": "hunter",
    "name": "Hunter"
  },
  "capability": "email.domain.count",
  "platform": "email",
  "kind": "data",
  "tier": "core",
  "identity": "key",
  "identityLabel": "Your plan",
  "price": {
    "amount": "Free",
    "state": "free",
    "label": "Free",
    "detail": "Free from the tool",
    "type": "free"
  },
  "providers": 1,
  "retention": "standard",
  "runsOn": "free",
  "live": true,
  "summary": "This API endpoint allows you to know how many email addresses we have for one domain or for one company.",
  "method": "GET",
  "path": "/email-count",
  "host": "https://api.hunter.io/v2",
  "docsUrl": "https://hunter.io/api-documentation/v2#email-count",
  "auth": {
    "scheme": "api_key",
    "label": "api_key · in header as X-API-KEY",
    "short": "api_key · x-api-key"
  },
  "scope": "any_account",
  "principal": "organization",
  "requiredScopes": [],
  "verification": {
    "state": "none",
    "label": "Not verified yet",
    "detail": "Not checked yet. We test with a real request before we mark it."
  },
  "input": [
    {
      "name": "domain",
      "location": "queryParams",
      "type": "string",
      "required": false,
      "constraints": [],
      "note": "Domain to count. Give domain or company; domain wins when both are given."
    },
    {
      "name": "company",
      "location": "queryParams",
      "type": "string",
      "required": false,
      "constraints": [],
      "note": "Company name, used when the domain is unknown. At least 3 characters."
    },
    {
      "name": "type",
      "location": "queryParams",
      "type": "string",
      "required": false,
      "constraints": [
        "one of \"personal\", \"generic\""
      ],
      "note": "Count only personal addresses, or only role-based (generic) ones."
    },
    {
      "name": "include_job_titles",
      "location": "queryParams",
      "type": "string",
      "required": false,
      "constraints": [],
      "note": "Any non-empty value adds data.job_titles, counts by job title. Listed in Hunter's OpenAPI, not on the docs page."
    }
  ],
  "sampleInput": {
    "domain": "stripe.com"
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "description": "Domain to count. Give domain or company; domain wins when both are given.",
        "examples": [
          "stripe.com"
        ]
      },
      "company": {
        "type": "string",
        "description": "Company name, used when the domain is unknown. At least 3 characters.",
        "examples": [
          "stripe"
        ]
      },
      "type": {
        "type": "string",
        "description": "Count only personal addresses, or only role-based (generic) ones.",
        "enum": [
          "personal",
          "generic"
        ]
      },
      "include_job_titles": {
        "type": "string",
        "description": "Any non-empty value adds data.job_titles, counts by job title. Listed in Hunter's OpenAPI, not on the docs page.",
        "examples": [
          "1"
        ]
      }
    },
    "additionalProperties": false
  },
  "output": [
    {
      "name": "data",
      "type": "object"
    },
    {
      "name": "meta",
      "type": "object"
    }
  ],
  "outputSchema": {
    "type": "object",
    "required": [
      "data",
      "meta"
    ],
    "properties": {
      "data": {
        "type": "object",
        "required": [
          "total",
          "personal_emails",
          "generic_emails",
          "department",
          "seniority"
        ],
        "properties": {
          "total": {
            "type": "integer"
          },
          "personal_emails": {
            "type": "integer"
          },
          "generic_emails": {
            "type": "integer"
          },
          "department": {
            "type": "object",
            "description": "Counts by department. Only emails with a known department are counted, so the sum can be below total.",
            "additionalProperties": {
              "type": "integer"
            }
          },
          "seniority": {
            "type": "object",
            "description": "Counts by seniority. Only emails with a known seniority are counted, so the sum can be below total.",
            "additionalProperties": {
              "type": "integer"
            }
          },
          "job_titles": {
            "type": "object",
            "additionalProperties": {
              "type": "integer"
            }
          }
        }
      },
      "meta": {
        "type": "object",
        "properties": {
          "params": {
            "type": "object"
          }
        }
      }
    }
  },
  "commands": {
    "mode": "run",
    "cli": "telipot run hunter.email.domain.count \\\n  --input-json '{\"domain\":\"stripe.com\"}'",
    "http": "curl https://api.telipot.com/v1/tasks/hunter.email.domain.count/run \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"domain\":\"stripe.com\"}'",
    "quote": "telipot run hunter.email.domain.count \\\n  --input-json '{\"domain\":\"stripe.com\"}' \\\n  --quote"
  },
  "siblings": []
}