View raw JSON
{
"type": "object",
"required": [],
"properties": {
"body": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"~standard": {
"vendor": "zod",
"version": 1,
"jsonSchema": {}
},
"properties": {
"type": {
"enum": [
"personal",
"generic"
],
"type": "string",
"description": "Only personal (a person's own address) or generic (role-based, e.g. contact@) addresses."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Max email addresses to return. Default 10, max 100. Billing is per started block of 10 returned addresses."
},
"domain": {
"type": "string",
"minLength": 1,
"description": "Domain name, e.g. 'stripe.com'. Preferred over company — it skips the name-to-domain conversion."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Addresses to skip — combine with limit to paginate (meta.results is the total). Each page bills separately."
},
"company": {
"type": "string",
"minLength": 3,
"description": "Company name, e.g. 'Stripe'. When both company and domain are given, domain wins."
},
"location": {
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string",
"description": "US state code — only valid when country is 'US'."
},
"country": {
"type": "string",
"maxLength": 2,
"minLength": 2,
"description": "ISO 3166-1 alpha-2 country code, e.g. 'US'."
},
"continent": {
"enum": [
"Africa",
"Antarctica",
"Asia",
"Europe",
"North America",
"Oceania",
"South America"
],
"type": "string"
},
"business_region": {
"enum": [
"AMER",
"EMEA",
"APAC",
"LATAM"
],
"type": "string"
}
},
"description": "A location: continent, business_region, or country (+ state/city)."
}
},
"include": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string",
"description": "US state code — only valid when country is 'US'."
},
"country": {
"type": "string",
"maxLength": 2,
"minLength": 2,
"description": "ISO 3166-1 alpha-2 country code, e.g. 'US'."
},
"continent": {
"enum": [
"Africa",
"Antarctica",
"Asia",
"Europe",
"North America",
"Oceania",
"South America"
],
"type": "string"
},
"business_region": {
"enum": [
"AMER",
"EMEA",
"APAC",
"LATAM"
],
"type": "string"
}
},
"description": "A location: continent, business_region, or country (+ state/city)."
}
}
},
"description": "Only people in (or not in) the given locations."
},
"seniority": {
"type": "string",
"minLength": 1,
"description": "Only people with the selected seniority level(s). Possible values: junior, senior, executive. Several values can be selected, comma-delimited."
},
"department": {
"type": "string",
"minLength": 1,
"description": "Only people in the selected department(s). Possible values: executive, it, finance, management, sales, legal, support, hr, marketing, communication, education, design, health, operations, product, research, consulting, administrative, procurement. Several values can be selected, comma-delimited."
},
"job_titles": {
"type": "string",
"minLength": 1,
"description": "Only people with the selected job title(s), comma-delimited. Common executive titles match their well-known equivalents (CTO matches Chief Technology Officer, VP matches Vice President)."
},
"aggregations": {
"type": "boolean",
"description": "Include a meta.aggregations breakdown: personal emails per department, decision-maker count, personal/generic split."
},
"decision_maker": {
"type": "boolean",
"description": "true → only likely decision makers; false → only non-decision-makers."
},
"required_field": {
"type": "string",
"minLength": 1,
"description": "Only addresses whose person record has the selected field(s). Possible values: full_name, position, phone_number. Several values can be selected, comma-delimited."
},
"verification_status": {
"type": "string",
"minLength": 1,
"description": "Only addresses with the selected verification status(es). Possible values: valid, accept_all, unknown. Several values can be selected, comma-delimited."
}
},
"description": "Provide at least one of domain or company (domain wins when both are given)."
}
},
"additionalProperties": false
}