{"openapi":"3.0.0","paths":{"/v5.1/account":{"get":{"operationId":"account","parameters":[],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51AccountResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Checking how many searches you have left.","tags":["account"]}},"/v5.1/domain/{domain}/email/download":{"get":{"description":"Please note that the file should have been paid previously using the payment endpoint. After the payment the file will be processed asynchronously, you have the option to receive a webhook once the file is ready.","operationId":"download","parameters":[{"name":"domain","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"content":{"text/csv":{}},"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Download a CSV file containing all the emails of a domain.","tags":["domain"]}},"/v5.1/domain/{domain}/email/order":{"post":{"description":"The payment will happen asynchronously, you can specify a url where we will send a webhook once the file is ready to be downloaded. Please note that emails provided in this file are not verified for accuracy.","operationId":"domainEmailOrder","parameters":[{"name":"domain","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Payment started.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51SuccessResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Pay to download the file containing all the emails of a domain.","tags":["domain"]}},"/v5.1/domain/{domain}/email":{"get":{"description":"This endpoint will return the number of emails available and the price to download the whole file.","operationId":"domainEmailInfo","parameters":[{"name":"domain","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Domain infos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51DomainEmailDownloadInfoDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Get the number of emails we have for a specified domain.","tags":["domain"]}},"/v5.1/report/bad-email":{"post":{"description":"Report an email address as bad or invalid.","operationId":"badEmail","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ReportBadEmailBodyDto"}}}},"responses":{"200":{"description":"Email reported successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51SuccessResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Report bad email","tags":["report"]}},"/v5.1/bulk/json":{"post":{"operationId":"createWithJson","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51BulkCreateWithJsonBodyDto"}}}},"responses":{"200":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api5SearchBulkDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Create a new bulk search by sending a CSV file in the request body.","tags":["bulk"]}},"/v5.1/bulk/multipart":{"post":{"operationId":"createWithMultipart","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File to be uploaded"},"company_name_field_index":{"type":"number","description":"The zero-based index of the column containing the company name in the uploaded file.","minimum":0},"domain_field_index":{"type":"number","description":"The zero-based index of the column containing the company website (domain) in the uploaded file.","minimum":0},"email_field_index":{"type":"number","description":"The zero-based index of the column containing the emails to validate in the uploaded file.","minimum":0},"file_name":{"type":"string","description":"A label to identify the bulk search."},"has_header":{"type":"boolean","description":"Whether the first row of the file contains headers. Defaults to true. Set to false if the first row is data."},"first_name_field_index":{"type":"number","description":"The zero-based index of the column containing the first name in the uploaded file.","minimum":0},"full_name_field_index":{"type":"number","description":"The zero-based index of the column containing the full name in the uploaded file.","minimum":0},"decision_maker_category":{"type":"array","items":{"type":"string"},"description":"One or more categories of the decision maker(s) to search for. If multiple are provided, they are treated in order of importance and the result will use the first category that resolves to a valid email. One or more of the following: \"ceo\", \"engineering\", \"finance\", \"hr\", \"it\", \"logistics\", \"marketing\", \"operations\", \"buyer\", \"sales\"."},"last_name_field_index":{"type":"number","description":"The zero-based index of the column containing the last name in the uploaded file.","minimum":0},"linkedin_url_field_index":{"type":"number","description":"The zero-based index of the column containing the Linkedin URL in the uploaded file.","minimum":0},"webhook_url":{"type":"string","description":"URL where we should send a webhook when the file processing has completed."}}}}}},"responses":{"200":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api5SearchBulkDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Create a new bulk search by uploading an Excel or CSV file.","tags":["bulk"]}},"/v5.1/bulk/{searchId}/download":{"get":{"operationId":"download","parameters":[{"name":"searchId","required":true,"in":"path","description":"The ID of the search","schema":{"example":"blk_xxxxxxxx","type":"string"}},{"name":"preview_only","required":false,"in":"query","description":"When true, downloads a preview version of the results without charging credits. Preview files exclude all paid information (such as emails or other data depending on the bulk search type). Defaults to false.","schema":{"enum":["true","false"],"type":"string"}},{"name":"partially_verified","required":false,"in":"query","description":"Include rows with risky emails in the download. Default: 1 (enabled).","schema":{"enum":["0","1"],"type":"string"}},{"name":"not_found","required":false,"in":"query","description":"Include rows where the email was not found in the download. Default: 1 (enabled).","schema":{"enum":["0","1"],"type":"string"}},{"name":"fully_verified","required":false,"in":"query","description":"Include rows with valid emails in the download. Default: 1 (enabled).","schema":{"enum":["0","1"],"type":"string"}},{"name":"format","required":false,"in":"query","description":"Setting to specify how the output file should be formatted.","schema":{"enum":["default","company-one-email-per-line"],"type":"string"}},{"name":"file_name_column_name","required":false,"in":"query","description":"If specified, appends a column containing the file name to the downloaded file.","schema":{"example":"file_name"}},{"name":"download_as","required":false,"in":"query","description":"Output file format (\"csv\", \"json_arr\", \"json_obj\" or \"xlsx\", defaults to \"csv\").","schema":{"example":"csv"}}],"responses":{"200":{"content":{"text/csv":{}},"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Download a CSV file containing the results of a bulk search.","tags":["bulk"]}},"/v5.1/bulk/{searchId}":{"get":{"operationId":"get","parameters":[{"name":"searchId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api5SearchBulkDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Retrieve the details of a bulk search.","tags":["bulk"]}},"/v5.1/find-email/company":{"post":{"description":"Retrieves emails associated with a given domain or company name. At least one parameter among \"company_name\" or \"domain\" is required. For better results, we recommend using the company website (domain) instead of the company name.","operationId":"company","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailCompanyBodyDto"}}}},"responses":{"200":{"description":"Emails found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailCompanyResponseSuccessDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Search for company emails based on company details.","tags":["find-email"]}},"/v5.1/find-email/decision-maker":{"post":{"description":"Find the details and emails of a decision maker of a specific category at a company. This search requires either \"company_name\" or \"domain\" to identify the company, and the \"decision_maker_category\".","operationId":"decisionMaker","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailDecisionMakerBodyDto"}}}},"responses":{"200":{"description":"Email found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailDecisionMakerResponseSuccessDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Search for a decision maker email based on company and category.","tags":["find-email"]}},"/v5.1/find-email/linkedin-url":{"post":{"description":"Retrieves a specific person's email within a company by providing a LinkedIn profile URL. This search requires just the \"linkedin_url\".","operationId":"linkedinUrl","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailLinkedinUrlBodyDto"}}}},"responses":{"200":{"description":"Email found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailLinkedinUrlResponseSuccessDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Search for a person's email based on a LinkedIn profile URL.","tags":["find-email"]}},"/v5.1/find-email/person":{"post":{"description":"Retrieves a specific person's email within a company by requiring details of both the company and the person. This search requires either \"company_name\" or \"domain\" to identify the company, and the person's name provided as \"full_name\" or both \"first_name\" and \"last_name\". For better results, we recommend using the company website (domain) instead of the company name.","operationId":"person","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailPersonBodyDto"}}}},"responses":{"200":{"description":"Email found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51FindEmailPersonResponseSuccessDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Search for a person's email based on company and personal details.","tags":["find-email"]}},"/v5.1/geo-lead":{"post":{"description":"Creates a bulk search that will generate leads from a specific geographic area. The search will find businesses or locations matching the provided query within the specified radius from the given coordinates. This is useful for location-based lead generation and market research.","operationId":"searchBulkGeoLeadCreate","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51GeoLeadCreateBodyDto"}}}},"responses":{"200":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api5GeoLeadDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Create a new GeoLead search based on geographic coordinates and search query.","tags":["geo-lead"]}},"/v5.1/geo-lead/{searchId}":{"get":{"operationId":"get","parameters":[{"name":"searchId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api5GeoLeadDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Retrieve the details of a GeoLead search.","tags":["geo-lead"]}},"/v5.1/geo-lead/{searchId}/download":{"get":{"operationId":"download","parameters":[{"name":"searchId","required":true,"in":"path","description":"The ID of the GeoLead search","schema":{"example":"blk_xxxxxxxx","type":"string"}},{"name":"preview_only","required":false,"in":"query","description":"When true, downloads a preview version of the results without charging credits. Preview files exclude all paid information (such as emails or other data depending on the bulk search type). Defaults to false.","schema":{"enum":["true","false"],"type":"string"}},{"name":"partially_verified","required":false,"in":"query","description":"Include rows with risky emails in the download. Default: 1 (enabled).","schema":{"enum":["0","1"],"type":"string"}},{"name":"not_found","required":false,"in":"query","description":"Include rows where the email was not found in the download. Default: 1 (enabled).","schema":{"enum":["0","1"],"type":"string"}},{"name":"fully_verified","required":false,"in":"query","description":"Include rows with valid emails in the download. Default: 1 (enabled).","schema":{"enum":["0","1"],"type":"string"}},{"name":"file_name_column_name","required":false,"in":"query","description":"If specified, appends a column containing the file name to the downloaded file.","schema":{"example":"file_name"}},{"name":"download_as","required":false,"in":"query","description":"Output file format (\"csv\", \"json_arr\", \"json_obj\" or \"xlsx\", defaults to \"csv\").","schema":{"example":"csv"}}],"responses":{"200":{"content":{"text/csv":{}},"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Download a CSV file containing the results of a GeoLead search.","tags":["geo-lead"]}},"/v5.1/verify-email":{"post":{"description":"Validates the provided email address to determine its authenticity and deliverability. The input requires a single email address. The response includes a \"validation\" field, which can be \"valid\" if the email is confirmed to be genuine and deliverable, \"invalid\" if the email is definitively non-existent or undeliverable, or \"risky\" if the validation process is inconclusive.","operationId":"validate","parameters":[{"name":"x-webhook-url","in":"header","description":"If provided, the result will be POSTed to this URL instead of waiting for the response.","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51VerifyEmailBodyDto"}}}},"responses":{"200":{"description":"Validation completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51VerifyEmailResponseSuccessDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}},"402":{"description":"Upgrade needed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Api51ErrorResponseDto"}}}}},"security":[{"api_key":[]}],"summary":"Validate an email.","tags":["verify-email"]}}},"info":{"title":"Anymail finder Api","description":"","version":"5.1","contact":{}},"tags":[],"servers":[{"url":"https://api.anymailfinder.com"}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"Api51AccountResponseDto":{"type":"object","properties":{"credits_left":{"type":"number","description":"How many credits are left."},"email":{"type":"string","description":"The email address associated with the account that owns the API key used to make the call.","example":"john@company.com"}},"required":["credits_left","email"]},"Api51ErrorResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Error code","example":"no_result"},"message":{"type":"string","description":"Detailed explanation of the error","example":"We could not find an email for this person. Sorry."}},"required":["error","message"]},"Api51SuccessResponseDto":{"type":"object","properties":{"input":{"type":"object","description":"Your request original input."}},"required":["input"]},"Api51DomainEmailDownloadInfoDto":{"type":"object","properties":{"credits_required":{"type":"number","description":"The number of credits required to download all emails for the domain.","example":123},"domain":{"type":"string","description":"The requested domain.","example":"anymailfinder.com"},"email_count":{"type":"number","description":"The total number of emails available in the database for this domain.","example":123},"status":{"nullable":true,"enum":["queued","ready"],"type":"string","description":"The status of the requested file (null = file not yet ordered, queued = file being prepared, ready = file ready to download).","example":null}},"required":["credits_required","domain","email_count","status"]},"Api51ReportBadEmailBodyDto":{"type":"object","properties":{"additional_info":{"type":"string","maxLength":500,"description":"Additional information about why the email is bad.","example":"Email bounced with permanent failure"},"bounce_message":{"type":"string","description":"Optional bounce message from the email server.","example":"550 5.1.1 <john.doe@microsoft.com>... User unknown"},"email":{"type":"string","format":"email","description":"The email address to report as bad.","example":"user@example.com"}},"required":["additional_info","email"]},"Api51BulkCreateWithJsonBodyDto":{"type":"object","properties":{"company_name_field_index":{"type":"number","minimum":0,"description":"The zero-based index of the column containing the company name in the uploaded file.","example":0},"data":{"type":"array","items":{"required":true,"description":"A multidimensional array containing rows and columns. The first row is expected to contain headers unless has_header is set to false.","example":[["company","name"],["Tesla","Elon Musk"]],"type":"array","items":{"type":"object"}}},"decision_maker_category":{"description":"One or more categories of the decision maker(s) to search for. If multiple are provided, they are treated in order of importance and the result will use the first category that resolves to a valid email. One or more of the following: \"ceo\", \"engineering\", \"finance\", \"hr\", \"it\", \"logistics\", \"marketing\", \"operations\", \"buyer\", \"sales\".","example":"ceo","type":"array","items":{"type":"string"}},"domain_field_index":{"type":"number","minimum":0,"description":"The zero-based index of the column containing the company website (domain) in the uploaded file.","example":null},"email_field_index":{"type":"number","minimum":0,"description":"The zero-based index of the column containing the emails to validate in the uploaded file.","example":null},"file_name":{"type":"string","description":"A label to identify the bulk search.","example":"my_search_name"},"first_name_field_index":{"type":"number","minimum":0,"description":"The zero-based index of the column containing the first name in the uploaded file.","example":null},"full_name_field_index":{"type":"number","minimum":0,"description":"The zero-based index of the column containing the full name in the uploaded file.","example":1},"has_header":{"type":"boolean","description":"Whether the first row of the data array contains headers. Defaults to true. Set to false if the first row is data.","example":true},"last_name_field_index":{"type":"number","minimum":0,"description":"The zero-based index of the column containing the last name in the uploaded file.","example":null},"linkedin_url_field_index":{"type":"number","minimum":0,"description":"The zero-based index of the column containing the Linkedin URL in the uploaded file.","example":null},"webhook_url":{"type":"string","description":"URL where we should send a webhook when the file processing has completed.","example":null}},"required":["data"]},"Api5SearchBulkDto":{"type":"object","properties":{"status":{"enum":["on_deck","queued","running","paused","completed","deleted","extraction_queued","extraction_running"],"type":"string","description":"The current status of the bulk operation. Each status represents a specific stage in the bulk operation lifecycle:<br />\n    - \"on_deck\": Indicates the bulk file has been uploaded through the UI, but the columns have not been mapped yet. This status is internal and typically not encountered by API users.<br />\n    - \"queued\": The bulk operation is queued and will be processed soon. This status implies that the operation is in the waiting list and will be picked up by the processing system.<br />\n    - \"running\": The bulk operation is currently in progress. This status indicates that the processing of the bulk file is actively ongoing.<br />\n    - \"paused\": The operation has been temporarily paused.<br />\n    - \"completed\": The bulk operation has been completed successfully. All records in the bulk file have been processed as intended.<br />\n    - \"failed\": The bulk operation has failed. This status indicates that there was an error during the processing which prevented the operation from completing successfully.<br />\n    Note: The status flow typically progresses from \"queued\" to \"running\", and then to either \"completed\" or \"failed\", but can also include \"paused\"."},"counts":{"type":"object","properties":{"failed":{"type":"number"},"found_unknown":{"type":"number"},"found_valid":{"type":"number"},"not_found":{"type":"number"},"total":{"type":"number"}},"required":["failed","found_unknown","found_valid","not_found","total"]},"created_at":{"format":"date-time","type":"string"},"credits_needed":{"type":"number"},"decision_maker_category":{"type":"string","nullable":true},"file_name":{"type":"string"},"id":{"type":"string"},"paid":{"type":"boolean"},"started_running_at":{"format":"date-time","type":"string","nullable":true}},"required":["status","counts","created_at","credits_needed","decision_maker_category","file_name","id","paid","started_running_at"]},"Api51FindEmailCompanyBodyDto":{"type":"object","properties":{"company_name":{"type":"string","description":"The company name (providing the domain is recommended for better accuracy)."},"domain":{"type":"string","description":"The domain of the company to search for emails."},"email_type":{"enum":["any","generic","personal"],"type":"string","description":"Specifies which type of email addresses to return in the results."}}},"Api51FindEmailCompanyResponseSuccessDto":{"type":"object","properties":{"input":{"type":"object","description":"Your request original input."},"credits_charged":{"type":"number","description":"Number of credits charged for this request."},"email_status":{"enum":["valid","risky","not_found","blacklisted"],"type":"string","description":"The email status. One of the following: valid, risky, not_found, blacklisted.","example":"valid"},"emails":{"description":"An array containing up to 20 email addresses found for the specified company.","example":["joedelia@hundo.io","help@hundo.io"],"type":"array","items":{"type":"string"}},"mx_domain":{"type":"string","nullable":true,"description":"The root domain of the MX hostname, e.g. google.com or outlook.com. null when mx_host is null.","example":"google.com"},"mx_host":{"type":"string","nullable":true,"description":"The domain's primary MX hostname, or null if no email was found.","example":"aspmx.l.google.com"},"valid_emails":{"description":"An array containing up to 20 email addresses found for the company, only when email_status is valid. Otherwise, this array is empty.","example":["joedelia@hundo.io","help@hundo.io"],"type":"array","items":{"type":"string"}}},"required":["input","credits_charged","email_status","emails","mx_domain","mx_host","valid_emails"]},"Api51FindEmailDecisionMakerBodyDto":{"type":"object","properties":{"company_name":{"type":"string","description":"Used if domain is not provided."},"decision_maker_category":{"description":"The category of the decision maker to search for. One or more of the following: \"ceo\", \"engineering\", \"finance\", \"hr\", \"it\", \"logistics\", \"marketing\", \"operations\", \"buyer\", \"sales\".","type":"array","items":{"type":"string"}},"domain":{"type":"string","description":"Preferred. The company domain."}},"required":["decision_maker_category"]},"Api51FindEmailDecisionMakerResponseSuccessDto":{"type":"object","properties":{"input":{"type":"object","description":"Your request original input."},"credits_charged":{"type":"number","description":"Number of credits charged for this request."},"decision_maker_category":{"type":"string","nullable":true,"description":"The decision maker category that matched, or null if not found.","example":"ceo"},"email":{"type":"string","nullable":true,"description":"The email found, or null if not found.","example":"satyan@microsoft.com"},"email_status":{"enum":["valid","risky","not_found","blacklisted"],"type":"string","description":"The email status. One of the following: valid, risky, not_found, blacklisted.","example":"valid"},"mx_domain":{"type":"string","nullable":true,"description":"The root domain of the MX hostname, e.g. google.com or outlook.com. null when mx_host is null.","example":"google.com"},"mx_host":{"type":"string","nullable":true,"description":"The domain's primary MX hostname, or null if no email was found.","example":"aspmx.l.google.com"},"person_first_name":{"type":"string","nullable":true,"description":"The decision maker's first (given) name. Null when the full name could not be confidently split into first and last name.","example":"Satya"},"person_full_name":{"type":"string","nullable":true,"description":"The full name of the decision maker.","example":"Satya Nadella"},"person_job_title":{"type":"string","nullable":true,"description":"The job title of the decision maker.","example":"Chairman and CEO"},"person_last_name":{"type":"string","nullable":true,"description":"The decision maker's last (family) name. Null when the full name could not be confidently split into first and last name.","example":"Nadella"},"person_linkedin_url":{"type":"string","nullable":true,"description":"The LinkedIn profile URL of the decision maker, if available.","example":"https://www.linkedin.com/in/satyanadella/"},"valid_email":{"type":"string","nullable":true,"description":"The email only when email_status is valid. Otherwise null.","example":"satyan@microsoft.com"}},"required":["input","credits_charged","decision_maker_category","email","email_status","mx_domain","mx_host","person_first_name","person_full_name","person_job_title","person_last_name","person_linkedin_url","valid_email"]},"Api51FindEmailLinkedinUrlBodyDto":{"type":"object","properties":{"linkedin_url":{"type":"string","description":"The LinkedIn profile URL of the person.","example":"https://www.linkedin.com/in/satyanadella/"}},"required":["linkedin_url"]},"Api51FindEmailLinkedinUrlResponseSuccessDto":{"type":"object","properties":{"input":{"type":"object","description":"Your request original input."},"credits_charged":{"type":"number","description":"Number of credits charged for this request."},"email":{"type":"string","nullable":true,"description":"The email found, or null if not found.","example":"satyan@microsoft.com"},"email_status":{"enum":["valid","risky","not_found","blacklisted"],"type":"string","description":"The email status. One of the following: valid, risky, not_found, blacklisted.","example":"valid"},"mx_domain":{"type":"string","nullable":true,"description":"The root domain of the MX hostname, e.g. google.com or outlook.com. null when mx_host is null.","example":"google.com"},"mx_host":{"type":"string","nullable":true,"description":"The domain's primary MX hostname, or null if no email was found.","example":"aspmx.l.google.com"},"person_company_name":{"type":"string","nullable":true,"description":"The person's company name.","example":"Microsoft"},"person_full_name":{"type":"string","nullable":true,"description":"The full name of the person.","example":"Satya Nadella"},"person_job_title":{"type":"string","nullable":true,"description":"The job title of the person.","example":"Chairman and CEO"},"valid_email":{"type":"string","nullable":true,"description":"The email only when email_status is valid. Otherwise null.","example":"satyan@microsoft.com"}},"required":["input","credits_charged","email","email_status","mx_domain","mx_host","person_company_name","person_full_name","person_job_title","valid_email"]},"Api51FindEmailPersonBodyDto":{"type":"object","properties":{"company_name":{"type":"string","description":"Used if domain is not provided."},"domain":{"type":"string","description":"Preferred. The company domain."},"first_name":{"type":"string","description":"First name of the person."},"full_name":{"type":"string","description":"Alternative to first+last name."},"last_name":{"type":"string","description":"Last name of the person."},"linkedin_url":{"type":"string","description":"Optional LinkedIn profile URL. When provided, the profile is used to refine the supplied name (e.g. extending 'John D.' to 'John Doe'), and is used as a fallback if the name+company lookup doesn't return a verified email. The result may be at a different company/domain if the person has moved.","example":"https://www.linkedin.com/in/satyanadella/"}}},"Api51FindEmailPersonResponseSuccessDto":{"type":"object","properties":{"input":{"type":"object","description":"Your request original input."},"credits_charged":{"type":"number","description":"Number of credits charged for this request."},"email":{"type":"string","nullable":true,"description":"The email found, or null if not found.","example":"satyan@microsoft.com"},"email_status":{"enum":["valid","risky","not_found","blacklisted"],"type":"string","description":"The email status. One of the following: valid, risky, not_found, blacklisted.","example":"valid"},"mx_domain":{"type":"string","nullable":true,"description":"The root domain of the MX hostname, e.g. google.com or outlook.com. null when mx_host is null.","example":"google.com"},"mx_host":{"type":"string","nullable":true,"description":"The domain's primary MX hostname, or null if no email was found.","example":"aspmx.l.google.com"},"person_company_name":{"type":"string","nullable":true,"description":"Name of the company at which the returned email lives. Populated when email_status is valid or risky, otherwise null.","example":"Microsoft"},"person_full_name":{"type":"string","nullable":true,"description":"Full name of the person we found the email for. May reflect a LinkedIn-extended version of the supplied name. Populated when email_status is valid or risky, otherwise null.","example":"Satya Nadella"},"person_job_title":{"type":"string","nullable":true,"description":"Job title of the person, sourced from LinkedIn. Populated when email_status is valid or risky AND a LinkedIn URL was provided whose profile we successfully fetched. Otherwise null.","example":"Chairman and CEO"},"valid_email":{"type":"string","nullable":true,"description":"The email only when email_status is valid. Otherwise null.","example":"satyan@microsoft.com"}},"required":["input","credits_charged","email","email_status","mx_domain","mx_host","person_company_name","person_full_name","person_job_title","valid_email"]},"Api51GeoLeadCreateBodyDto":{"type":"object","properties":{"file_name":{"type":"string","description":"A label to identify the geo lead search.","example":"my_geo_lead_search"},"find_company_emails":{"type":"boolean","description":"Whether to search for company emails. If false, only decision maker emails will be searched. Defaults to true.","example":true},"find_decision_maker_categories":{"description":"Decision maker categories to search for. If not provided, defaults to [\"ceo\"]. If empty array [], no decision maker search will be performed. Valid categories: \"ceo\", \"engineering\", \"finance\", \"hr\", \"it\", \"logistics\", \"marketing\", \"operations\", \"buyer\", \"sales\".","example":["ceo"],"type":"array","items":{"type":"string"}},"latitude":{"type":"number","description":"The latitude coordinate for the search center point.","example":40.7127753,"maximum":90,"minimum":-90},"longitude":{"type":"number","description":"The longitude coordinate for the search center point.","example":-74.0059728,"maximum":180,"minimum":-180},"query":{"type":"string","description":"The search query to find businesses or locations within the specified radius.","example":"restaurants"},"radius_km":{"type":"number","minimum":1,"maximum":25,"description":"The search radius in km from the center point.","example":1},"result_limit":{"type":"number","nullable":true,"minimum":1,"description":"Optional limit on the number of leads to extract. If specified, the extraction will stop once this limit is reached.","example":100}},"required":["find_company_emails","find_decision_maker_categories","latitude","longitude","query","radius_km"]},"Api5GeoLeadDto":{"type":"object","properties":{"status":{"enum":["on_deck","queued","running","paused","completed","deleted","extraction_queued","extraction_running"],"type":"string","description":"The current status of the GeoLead search:<br />\n    - \"extraction_queued\": The search for companies matching the specified criteria is queued and will start soon.<br />\n    - \"extraction_running\": The search for companies is in progress.<br />\n    - \"queued\": The search for emails of the found companies is queued and will start soon.<br />\n    - \"running\": The search for emails of the found companies is in progress.<br />\n    - \"paused\": The GeoLead search has been temporarily paused.<br />\n    - \"completed\": The GeoLead search has finished successfully.<br />\n    - \"failed\": The GeoLead search has failed. This indicates that an error occurred during processing and the operation could not complete."},"counts":{"type":"object","properties":{"failed":{"type":"number"},"found_unknown":{"type":"number"},"found_valid":{"type":"number"},"not_found":{"type":"number"},"total":{"type":"number"}},"required":["failed","found_unknown","found_valid","not_found","total"]},"created_at":{"format":"date-time","type":"string"},"credits_needed":{"type":"number"},"file_name":{"type":"string"},"find_company_emails":{"type":"boolean"},"find_decision_maker_categories":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"paid":{"type":"boolean"},"query":{"type":"string"},"radius_km":{"type":"number"},"result_limit":{"type":"number","nullable":true},"started_running_at":{"format":"date-time","type":"string","nullable":true}},"required":["status","counts","created_at","credits_needed","file_name","find_company_emails","find_decision_maker_categories","id","latitude","longitude","paid","query","radius_km","started_running_at"]},"Api51VerifyEmailBodyDto":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The email to validate."}},"required":["email"]},"Api51VerifyEmailResponseSuccessDto":{"type":"object","properties":{"input":{"type":"object","description":"Your request original input."},"credits_charged":{"type":"number","description":"Number of credits charged for this request."},"email_status":{"enum":["valid","risky","invalid"],"type":"string","description":"The result of the email validation: 'valid', 'risky' or 'invalid'."},"mx_domain":{"type":"string","nullable":true,"description":"The root domain of the MX hostname, e.g. google.com or outlook.com. null if mx_host is null.","example":"google.com"},"mx_host":{"type":"string","nullable":true,"description":"The domain's primary MX hostname, or null if none found.","example":"aspmx.l.google.com"}},"required":["input","credits_charged","email_status","mx_domain","mx_host"]}}}}