{ "openapi": "3.0.3", "info": { "title": "Hunter API", "version": "2.0.0", "description": "Find and verify professional email addresses and manage Hunter resources.", "contact": { "name": "Hunter Support", "url": "https://help.hunter.io" } }, "servers": [ { "url": "https://api.hunter.io/v2", "description": "Production" } ], "security": [ { "apiKeyQuery": [] }, { "apiKeyHeader": [] }, { "bearerAuth": [] } ], "paths": { "/discover": { "post": { "operationId": "discoverCompanies", "summary": "Discover companies", "description": "Find companies matching a structured filter set. This operation is free.", "tags": [ "Discover" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discover_request" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/discover_request" } } } }, "responses": { "200": { "description": "Matching companies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discover_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "403": { "$ref": "#/components/responses/Error" }, "503": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domain-search": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "domain", "in": "query", "description": "Domain name to search.", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Company name to search when the domain is unknown.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "personal", "generic" ] } }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "name": "department", "in": "query", "description": "Comma-separated department values from Hunter's live position taxonomy (not a frozen enum). `~` matches people with no department. Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_department`).\n", "schema": { "type": "string", "example": "sales,marketing" } }, { "name": "source_type", "in": "query", "schema": { "type": "string", "enum": [ "found", "generated" ] } }, { "name": "job_titles", "in": "query", "schema": { "type": "string" } }, { "name": "seniority", "in": "query", "description": "Comma-separated seniority values from Hunter's live position taxonomy (not a frozen enum). Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_seniority`).\n", "schema": { "type": "string", "example": "senior,executive" } }, { "name": "decision_maker", "in": "query", "schema": { "$ref": "#/components/schemas/strict_boolean_filter" } }, { "name": "required_field", "in": "query", "schema": { "type": "string" } }, { "name": "verification_status", "in": "query", "schema": { "type": "string" } }, { "name": "aggregations", "in": "query", "schema": { "type": "boolean" } }, { "name": "saved_leads", "in": "query", "schema": { "type": "boolean" } } ], "get": { "operationId": "searchDomain", "summary": "Find email addresses by domain", "tags": [ "Finder" ], "responses": { "200": { "description": "Email addresses and public sources for the domain.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_search_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "searchDomainWithPost", "summary": "Find email addresses by domain using request-body parameters", "description": "Use POST for nested location filters. The body can be JSON or URL-encoded form data.", "tags": [ "Finder" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/domain_search_request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/domain_search_request" } } } }, "responses": { "200": { "description": "Email addresses and public sources for the domain.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_search_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-finder": { "get": { "operationId": "findEmail", "summary": "Find a professional email address", "description": "Supply a LinkedIn handle, or supply a domain/company plus either a full name or first and last name. A found email address is also saved automatically to your leads. This is enabled by default and can be disabled for your account.", "tags": [ "Finder" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "domain", "in": "query", "schema": { "type": "string" } }, { "name": "company", "in": "query", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "schema": { "type": "string" } }, { "name": "linkedin_handle", "in": "query", "schema": { "type": "string" } }, { "name": "max_duration", "in": "query", "schema": { "type": "integer", "minimum": 3, "maximum": 20, "default": 10 } } ], "responses": { "200": { "description": "The best matching email and supporting sources.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_finder_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-verifier": { "get": { "operationId": "verifyEmail", "summary": "Verify an email address", "description": "Check the deliverability of an email address. A verified email address is also saved automatically to your leads. This is enabled by default and can be disabled for your account.", "tags": [ "Verifier" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "domain_metadata", "in": "query", "description": "Include metadata about the email domain when set to any non-empty value. An empty value or omission disables it.", "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "Deliverability status and verification checks.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_verifier_response" } } } }, "202": { "description": "Verification is still in progress and can be polled again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pending_envelope" } } } }, "222": { "description": "Verification failed for reasons outside Hunter's control and can be retried later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "451": { "description": "The claimed email address cannot be processed for privacy reasons.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_response" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-count": { "get": { "operationId": "countDomainEmails", "summary": "Count email addresses for a domain", "description": "Return aggregate counts without revealing individual email addresses. This operation is free.", "tags": [ "Finder" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "domain", "in": "query", "description": "Domain name to count.", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Company name to count when the domain is unknown.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "personal", "generic" ] } }, { "name": "include_job_titles", "in": "query", "description": "Include job-title counts when set to any non-empty value. An empty value or omission disables it.", "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "Aggregate email counts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_count_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/people/find": { "get": { "operationId": "enrichPerson", "summary": "Enrich a person", "tags": [ "Enrichment" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "email", "in": "query", "description": "Email address to enrich.", "schema": { "type": "string", "format": "email" } }, { "name": "linkedin_handle", "in": "query", "description": "LinkedIn profile handle to enrich.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ClearbitFormat" } ], "responses": { "200": { "description": "Enriched person data.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/person_enrichment_response" }, { "$ref": "#/components/schemas/person" } ] } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/find": { "get": { "operationId": "enrichCompany", "summary": "Enrich a company", "tags": [ "Enrichment" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "domain", "in": "query", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ClearbitFormat" } ], "responses": { "200": { "description": "Enriched company data.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/company_enrichment_response" }, { "$ref": "#/components/schemas/company" } ] } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/combined/find": { "get": { "operationId": "enrichPersonAndCompany", "summary": "Enrich a person and company", "tags": [ "Enrichment" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "email", "in": "query", "description": "Email address to enrich.", "schema": { "type": "string", "format": "email" } }, { "name": "linkedin_handle", "in": "query", "description": "LinkedIn profile handle to enrich.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ClearbitFormat" } ], "responses": { "200": { "description": "Enriched person and company data.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/combined_enrichment_response" }, { "$ref": "#/components/schemas/combined_clearbit_response" } ] } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "404": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/account": { "get": { "operationId": "getAccount", "summary": "Get account details and usage", "tags": [ "Account" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "responses": { "200": { "description": "Account, plan, team, and quota details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "updateAccount", "summary": "Update account details", "tags": [ "Account" ], "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "responses": { "204": { "description": "Account updated, no content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/account-stats": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "getAccountStats", "summary": "Get account profile summary", "tags": [ "Account" ], "responses": { "200": { "description": "Account profile summary with identity, plan, and most used source.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/usage": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "getUsage", "summary": "Get credit usage summary", "tags": [ "Usage" ], "responses": { "200": { "description": "Get credit usage summary.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/usage/history": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "getUsageHistory", "summary": "Get credit usage history", "tags": [ "Usage" ], "responses": { "200": { "description": "Get credit usage history.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/team/members": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listTeamMembers", "summary": "List team members", "tags": [ "Team" ], "responses": { "200": { "description": "List team members.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/connected-apps": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listConnectedApps", "summary": "List connected apps", "tags": [ "Connected Apps" ], "responses": { "200": { "description": "List connected apps.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/connected-apps/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getConnectedApp", "summary": "Get a connected app", "tags": [ "Connected Apps" ], "responses": { "200": { "description": "Get a connected app.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/connected-apps/{id}/push": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "pushToConnectedApp", "summary": "Push data to a connected app", "tags": [ "Connected Apps" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-accounts": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listEmailAccounts", "summary": "List email accounts", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "List email accounts.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-accounts/capacities": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "getEmailAccountCapacities", "summary": "Get email account sending capacities", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "Get email account sending capacities.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-accounts/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getEmailAccount", "summary": "Get an email account", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "Get an email account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateEmailAccount", "summary": "Update an email account", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "Update an email account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceEmailAccount", "summary": "Replace an email account", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "Replace an email account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-accounts/{id}/health-report": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getEmailAccountHealthReport", "summary": "Get an email account health report", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "Get an email account health report.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-accounts/{id}/usage": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getEmailAccountUsage", "summary": "Get an email account usage report", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "Get an email account usage report.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-accounts/{id}/warmup-report": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getEmailAccountWarmupReport", "summary": "Get an email account warmup report", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "Get an email account warmup report.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-accounts/{id}/sequences": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listEmailAccountSequences", "summary": "List sequences using an email account", "tags": [ "Email Accounts" ], "responses": { "200": { "description": "List sequences using an email account.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/campaigns": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listCampaigns", "summary": "List campaigns", "tags": [ "Campaigns" ], "responses": { "200": { "description": "List campaigns.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/campaigns/{id}/recipients": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listCampaignRecipients", "summary": "List campaign recipients", "tags": [ "Campaigns" ], "responses": { "200": { "description": "List campaign recipients.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "addCampaignRecipients", "summary": "Add campaign recipients", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Add campaign recipients.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "removeCampaignRecipients", "summary": "Remove campaign recipients", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Remove campaign recipients.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/campaigns/{id}/start": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "startCampaign", "summary": "Start a campaign", "tags": [ "Campaigns" ], "responses": { "200": { "description": "Start a campaign.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/campaigns/{id}/follow-ups": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "createCampaignFollowUp", "summary": "Add a campaign follow-up step", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Add a campaign follow-up step.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/campaigns/{id}/follow-ups/{follow_up_id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "follow_up_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getCampaignFollowUp", "summary": "Get a campaign follow-up step", "tags": [ "Campaigns" ], "responses": { "200": { "description": "Get a campaign follow-up step.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listSequences", "summary": "List sequences", "tags": [ "Sequences" ], "responses": { "200": { "description": "List sequences.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createSequence", "summary": "Create a sequence", "tags": [ "Sequences" ], "responses": { "201": { "description": "Create a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getSequence", "summary": "Get a sequence", "tags": [ "Sequences" ], "responses": { "200": { "description": "Get a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateSequence", "summary": "Update a sequence", "tags": [ "Sequences" ], "responses": { "200": { "description": "Update a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceSequence", "summary": "Replace a sequence", "tags": [ "Sequences" ], "responses": { "200": { "description": "Replace a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteSequence", "summary": "Delete a sequence", "tags": [ "Sequences" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{id}/follow-ups": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listSequenceFollowUps", "summary": "List sequence follow-up steps", "tags": [ "Sequences" ], "responses": { "200": { "description": "List sequence follow-up steps.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createSequenceFollowUp", "summary": "Add a sequence follow-up step", "tags": [ "Sequences" ], "responses": { "201": { "description": "Add a sequence follow-up step.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{id}/follow-ups/{follow_up_id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "follow_up_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getSequenceFollowUp", "summary": "Get a sequence follow-up step", "tags": [ "Sequences" ], "responses": { "200": { "description": "Get a sequence follow-up step.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateSequenceFollowUp", "summary": "Update a sequence follow-up step", "tags": [ "Sequences" ], "responses": { "200": { "description": "Update a sequence follow-up step.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceSequenceFollowUp", "summary": "Replace a sequence follow-up step", "tags": [ "Sequences" ], "responses": { "200": { "description": "Replace a sequence follow-up step.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteSequenceFollowUp", "summary": "Delete a sequence follow-up step", "tags": [ "Sequences" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{id}/stats": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getSequenceStats", "summary": "Get sequence performance stats", "tags": [ "Sequences" ], "responses": { "200": { "description": "Get sequence performance stats.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{id}/recipients": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "listSequenceRecipients", "summary": "List sequence recipients", "tags": [ "Sequences" ], "responses": { "200": { "description": "List sequence recipients.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "addSequenceRecipients", "summary": "Add sequence recipients", "tags": [ "Sequences" ], "responses": { "201": { "description": "Add sequence recipients.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "removeSequenceRecipients", "summary": "Remove sequence recipients", "tags": [ "Sequences" ], "responses": { "201": { "description": "Remove sequence recipients.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{id}/start": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "startSequence", "summary": "Start a sequence", "tags": [ "Sequences" ], "responses": { "200": { "description": "Start a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{sequence_id}/pause": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "sequence_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "pauseSequence", "summary": "Pause a sequence", "tags": [ "Sequences" ], "responses": { "200": { "description": "Pause a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "resumeSequence", "summary": "Resume a paused sequence", "tags": [ "Sequences" ], "responses": { "200": { "description": "Resume a paused sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/sequences/{sequence_id}/archive": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "sequence_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "archiveSequence", "summary": "Archive a sequence", "tags": [ "Sequences" ], "responses": { "200": { "description": "Archive a sequence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/discover/people": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "discoverPeople", "summary": "Discover people matching filters", "tags": [ "Discover" ], "responses": { "200": { "description": "Discover people matching filters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "discoverPeopleWithPost", "summary": "Discover people using request-body filters", "tags": [ "Discover" ], "responses": { "200": { "description": "Discover people using request-body filters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domain-count": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "countDomains", "summary": "Count domains matching discovery filters", "tags": [ "Finder" ], "security": [], "responses": { "200": { "description": "Count domains matching discovery filters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domain-search/found": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "domain", "in": "query", "description": "Domain name to search.", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Company name to search when the domain is unknown.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "personal", "generic" ] } }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Offset" }, { "name": "department", "in": "query", "description": "Comma-separated department values from Hunter's live position taxonomy (not a frozen enum). `~` matches people with no department. Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_department`).\n", "schema": { "type": "string", "example": "sales,marketing" } }, { "name": "job_titles", "in": "query", "schema": { "type": "string" } }, { "name": "seniority", "in": "query", "description": "Comma-separated seniority values from Hunter's live position taxonomy (not a frozen enum). Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_seniority`).\n", "schema": { "type": "string", "example": "senior,executive" } }, { "name": "decision_maker", "in": "query", "schema": { "$ref": "#/components/schemas/strict_boolean_filter" } }, { "name": "required_field", "in": "query", "schema": { "type": "string" } }, { "name": "verification_status", "in": "query", "schema": { "type": "string" } }, { "name": "aggregations", "in": "query", "schema": { "type": "boolean" } }, { "name": "saved_leads", "in": "query", "schema": { "type": "boolean" } } ], "get": { "operationId": "searchDomainFound", "summary": "Find previously found emails by domain", "description": "Found-only variant of domain search. source_type is forced to found server-side.", "tags": [ "Finder" ], "responses": { "200": { "description": "Previously found email addresses and public sources for the domain.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_search_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "searchDomainFoundWithPost", "summary": "Find previously found emails by domain via POST", "description": "Use POST for nested location filters. The body can be JSON or URL-encoded form data.", "tags": [ "Finder" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/domain_search_request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/domain_search_request" } } } }, "responses": { "200": { "description": "Previously found email addresses and public sources for the domain.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_search_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domain-finder": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "company", "in": "query", "description": "Company name to resolve to a domain.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum suggestions to return.", "schema": { "type": "integer" } }, { "name": "perfect_match", "in": "query", "description": "Only return an exact company-name match.", "schema": { "type": "boolean" } } ], "get": { "operationId": "findDomain", "summary": "Find the domain for a company", "tags": [ "Finder" ], "responses": { "200": { "description": "Find the domain for a company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "findDomainWithPost", "summary": "Find the domain for a company via POST", "tags": [ "Finder" ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/domain_finder_request" } }, "application/json": { "schema": { "$ref": "#/components/schemas/domain_finder_request" } } } }, "responses": { "200": { "description": "Find the domain for a company via POST.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/multi-domain-search": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "multiDomainSearch", "summary": "Search emails across multiple domains", "tags": [ "Finder" ], "responses": { "200": { "description": "Search emails across multiple domains.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/multi-domain-search/reveal": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "revealMultiDomainSearch", "summary": "Reveal emails from a multi-domain search", "tags": [ "Finder" ], "responses": { "200": { "description": "Reveal emails from a multi-domain search.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domains-suggestion": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "query", "in": "query", "description": "Company name to suggest domains for.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum suggestions to return.", "schema": { "type": "integer" } } ], "get": { "operationId": "suggestDomains", "summary": "Suggest domains for a company name", "tags": [ "Finder" ], "responses": { "200": { "description": "Suggest domains for a company name.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-finder/found": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "domain", "in": "query", "schema": { "type": "string" } }, { "name": "company", "in": "query", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "schema": { "type": "string" } }, { "name": "linkedin_handle", "in": "query", "schema": { "type": "string" } }, { "name": "max_duration", "in": "query", "schema": { "type": "integer", "minimum": 3, "maximum": 20, "default": 10 } } ], "get": { "operationId": "findEmailFound", "summary": "Get a previously found email address", "description": "Found-only variant of email finder. Supply a LinkedIn handle, or supply a domain/company plus either a full name or first and last name.", "tags": [ "Finder" ], "responses": { "200": { "description": "The best matching found email and supporting sources.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_finder_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "findEmailFoundWithPost", "summary": "Get a previously found email address via POST", "description": "Found-only variant of email finder using request-body parameters.", "tags": [ "Finder" ], "responses": { "200": { "description": "The best matching found email and supporting sources.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/email_finder_response" } } } }, "400": { "$ref": "#/components/responses/Error" }, "401": { "$ref": "#/components/responses/Error" }, "429": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/email-insight": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "email", "in": "query", "description": "Email address to inspect.", "schema": { "type": "string", "format": "email" } } ], "get": { "operationId": "getEmailInsight", "summary": "Get deliverability insight for an email address", "tags": [ "Verifier" ], "security": [], "responses": { "200": { "description": "Get deliverability insight for an email address.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listLeads", "summary": "List leads", "tags": [ "Leads" ], "responses": { "200": { "description": "List leads.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createLead", "summary": "Create a lead", "tags": [ "Leads" ], "responses": { "201": { "description": "Create a lead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "upsertLeads", "summary": "Bulk upsert leads", "tags": [ "Leads" ], "responses": { "200": { "description": "Bulk upsert leads.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "201": { "description": "Bulk upsert leads.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getLead", "summary": "Get a lead", "tags": [ "Leads" ], "responses": { "200": { "description": "Get a lead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateLead", "summary": "Update a lead", "tags": [ "Leads" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceLead", "summary": "Replace a lead", "tags": [ "Leads" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteLead", "summary": "Delete a lead", "tags": [ "Leads" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/exist": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "email", "in": "query", "description": "Email address to look up.", "schema": { "type": "string", "format": "email" } } ], "get": { "operationId": "checkLeadExists", "summary": "Check whether a lead exists", "tags": [ "Leads" ], "responses": { "200": { "description": "Check whether a lead exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/bulk/exist": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "emails", "in": "query", "description": "Email addresses to look up in bulk. Send Rails-style bracket encoding (emails[]=a@example.com&emails[]=b@example.com): the comma-joined and repeated-key forms parse as a scalar and fail validation.", "schema": { "type": "array", "items": { "type": "string", "format": "email" } } } ], "get": { "operationId": "checkLeadsBulkExist", "summary": "Check whether leads exist in bulk", "tags": [ "Leads" ], "responses": { "200": { "description": "Check whether leads exist in bulk.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/bulk/move": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "moveLeadsBulk", "summary": "Move leads to another list in bulk", "tags": [ "Leads" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/bulk/delete": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "deleteLeadsBulk", "summary": "Delete leads in bulk", "tags": [ "Leads" ], "responses": { "200": { "description": "Delete leads in bulk.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/companies": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "saveLeadCompany", "summary": "Save a company", "tags": [ "Leads" ], "responses": { "201": { "description": "Save a company as a saved-company record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/{id}/tags": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "tagLead", "summary": "Tag a lead", "tags": [ "Leads" ], "responses": { "201": { "description": "Tag a lead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/{id}/tags/{tag_id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "delete": { "operationId": "untagLead", "summary": "Remove a tag from a lead", "tags": [ "Leads" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads/{id}/enrich": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "enrichLead", "summary": "Enrich a lead", "tags": [ "Leads" ], "responses": { "200": { "description": "Enrich a lead.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_custom_attributes": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listLeadCustomAttributes", "summary": "List lead custom attributes", "tags": [ "Leads" ], "responses": { "200": { "description": "List lead custom attributes.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createLeadCustomAttribute", "summary": "Create a lead custom attribute", "tags": [ "Leads" ], "responses": { "201": { "description": "Create a lead custom attribute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_custom_attributes/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getLeadCustomAttribute", "summary": "Get a lead custom attribute", "tags": [ "Leads" ], "responses": { "200": { "description": "Get a lead custom attribute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateLeadCustomAttribute", "summary": "Update a lead custom attribute", "tags": [ "Leads" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceLeadCustomAttribute", "summary": "Replace a lead custom attribute", "tags": [ "Leads" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteLeadCustomAttribute", "summary": "Delete a lead custom attribute", "tags": [ "Leads" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listCompanies", "summary": "List saved companies", "tags": [ "Companies" ], "responses": { "200": { "description": "List saved companies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createCompany", "summary": "Save a company", "tags": [ "Companies" ], "responses": { "201": { "description": "Save a company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getCompany", "summary": "Get a saved company", "tags": [ "Companies" ], "responses": { "200": { "description": "Get a saved company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteCompany", "summary": "Delete a saved company", "tags": [ "Companies" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/bulk/move": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "moveCompaniesBulk", "summary": "Move companies to another list in bulk", "tags": [ "Companies" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/bulk/copy": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "copyCompaniesBulk", "summary": "Copy companies to another list in bulk", "tags": [ "Companies" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/bulk/delete": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "deleteCompaniesBulk", "summary": "Delete companies in bulk", "tags": [ "Companies" ], "responses": { "200": { "description": "Delete companies in bulk.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/bulk/tag": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "tagCompaniesBulk", "summary": "Tag companies in bulk", "tags": [ "Companies" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/{id}/tags": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "tagSavedCompany", "summary": "Tag a saved company", "tags": [ "Companies" ], "responses": { "201": { "description": "Tag a saved company.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/companies/{id}/tags/{tag_id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tag_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "delete": { "operationId": "untagSavedCompany", "summary": "Remove a tag from a saved company", "tags": [ "Companies" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_lists": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listLeadLists", "summary": "List lead lists", "tags": [ "Lists" ], "responses": { "200": { "description": "List lead lists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createLeadList", "summary": "Create a lead list", "tags": [ "Lists" ], "responses": { "201": { "description": "Create a lead list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_lists/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getLeadList", "summary": "Get a lead list", "tags": [ "Lists" ], "responses": { "200": { "description": "Get a lead list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateLeadList", "summary": "Update a lead list", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceLeadList", "summary": "Replace a lead list", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteLeadList", "summary": "Delete a lead list", "tags": [ "Lists" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_lists/folders": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listLeadListFolders", "summary": "List lead list folders", "tags": [ "Lists" ], "responses": { "200": { "description": "List lead list folders.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createLeadListFolder", "summary": "Create a lead list folder", "tags": [ "Lists" ], "responses": { "201": { "description": "Create a lead list folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_lists/folders/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getLeadListFolder", "summary": "Get a lead list folder", "tags": [ "Lists" ], "responses": { "200": { "description": "Get a lead list folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateLeadListFolder", "summary": "Update a lead list folder", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceLeadListFolder", "summary": "Replace a lead list folder", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteLeadListFolder", "summary": "Delete a lead list folder", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_lists/{id}/favorite": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "favoriteLeadList", "summary": "Favorite a lead list", "tags": [ "Lists" ], "responses": { "201": { "description": "Favorite a lead list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "unfavoriteLeadList", "summary": "Unfavorite a lead list", "tags": [ "Lists" ], "responses": { "200": { "description": "Unfavorite a lead list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads_lists/{id}/merge": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "mergeLeadLists", "summary": "Merge lead lists", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads-lists": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listLeadListsHyphen", "summary": "List lead lists (hyphen alias)", "tags": [ "Lists" ], "responses": { "200": { "description": "List lead lists (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createLeadListHyphen", "summary": "Create a lead list (hyphen alias)", "tags": [ "Lists" ], "responses": { "201": { "description": "Create a lead list (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads-lists/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getLeadListHyphen", "summary": "Get a lead list (hyphen alias)", "tags": [ "Lists" ], "responses": { "200": { "description": "Get a lead list (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateLeadListHyphen", "summary": "Update a lead list (hyphen alias)", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceLeadListHyphen", "summary": "Replace a lead list (hyphen alias)", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteLeadListHyphen", "summary": "Delete a lead list (hyphen alias)", "tags": [ "Lists" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads-lists/folders": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listLeadListFoldersHyphen", "summary": "List lead list folders (hyphen alias)", "tags": [ "Lists" ], "responses": { "200": { "description": "List lead list folders (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createLeadListFolderHyphen", "summary": "Create a lead list folder (hyphen alias)", "tags": [ "Lists" ], "responses": { "201": { "description": "Create a lead list folder (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads-lists/folders/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getLeadListFolderHyphen", "summary": "Get a lead list folder (hyphen alias)", "tags": [ "Lists" ], "responses": { "200": { "description": "Get a lead list folder (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateLeadListFolderHyphen", "summary": "Update a lead list folder (hyphen alias)", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceLeadListFolderHyphen", "summary": "Replace a lead list folder (hyphen alias)", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteLeadListFolderHyphen", "summary": "Delete a lead list folder (hyphen alias)", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads-lists/{id}/favorite": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "favoriteLeadListHyphen", "summary": "Favorite a lead list (hyphen alias)", "tags": [ "Lists" ], "responses": { "201": { "description": "Favorite a lead list (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "unfavoriteLeadListHyphen", "summary": "Unfavorite a lead list (hyphen alias)", "tags": [ "Lists" ], "responses": { "200": { "description": "Unfavorite a lead list (hyphen alias).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/leads-lists/{id}/merge": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "mergeLeadListsHyphen", "summary": "Merge lead lists (hyphen alias)", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-lists": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listCompanyLists", "summary": "List company lists", "tags": [ "Lists" ], "responses": { "200": { "description": "List company lists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createCompanyList", "summary": "Create a company list", "tags": [ "Lists" ], "responses": { "201": { "description": "Create a company list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-lists/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getCompanyList", "summary": "Get a company list", "tags": [ "Lists" ], "responses": { "200": { "description": "Get a company list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateCompanyList", "summary": "Update a company list", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceCompanyList", "summary": "Replace a company list", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteCompanyList", "summary": "Delete a company list", "tags": [ "Lists" ], "responses": { "202": { "description": "Accepted for background processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-lists/folders": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listCompanyListFolders", "summary": "List company list folders", "tags": [ "Lists" ], "responses": { "200": { "description": "List company list folders.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createCompanyListFolder", "summary": "Create a company list folder", "tags": [ "Lists" ], "responses": { "201": { "description": "Create a company list folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-lists/folders/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getCompanyListFolder", "summary": "Get a company list folder", "tags": [ "Lists" ], "responses": { "200": { "description": "Get a company list folder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateCompanyListFolder", "summary": "Update a company list folder", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceCompanyListFolder", "summary": "Replace a company list folder", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteCompanyListFolder", "summary": "Delete a company list folder", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-lists/{id}/favorite": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "favoriteCompanyList", "summary": "Favorite a company list", "tags": [ "Lists" ], "responses": { "201": { "description": "Favorite a company list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "unfavoriteCompanyList", "summary": "Unfavorite a company list", "tags": [ "Lists" ], "responses": { "200": { "description": "Unfavorite a company list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-lists/{id}/companies": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "post": { "operationId": "addCompanyListCompany", "summary": "Add a company to a company list", "tags": [ "Lists" ], "responses": { "201": { "description": "Add a company to a company list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-lists/{id}/companies/{company_id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "delete": { "operationId": "removeCompanyListCompany", "summary": "Remove a company from a company list", "tags": [ "Lists" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/tags": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listTags", "summary": "List lead tags", "tags": [ "Tags" ], "responses": { "200": { "description": "List lead tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createTag", "summary": "Create a lead tag", "tags": [ "Tags" ], "responses": { "201": { "description": "Create a lead tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/tags/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getTag", "summary": "Get a lead tag", "tags": [ "Tags" ], "responses": { "200": { "description": "Get a lead tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateTag", "summary": "Update a lead tag", "tags": [ "Tags" ], "responses": { "200": { "description": "Update a lead tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceTag", "summary": "Replace a lead tag", "tags": [ "Tags" ], "responses": { "200": { "description": "Replace a lead tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteTag", "summary": "Delete a lead tag", "tags": [ "Tags" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-tags": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listCompanyTags", "summary": "List company tags", "tags": [ "Tags" ], "responses": { "200": { "description": "List company tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createCompanyTag", "summary": "Create a company tag", "tags": [ "Tags" ], "responses": { "201": { "description": "Create a company tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/company-tags/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getCompanyTag", "summary": "Get a company tag", "tags": [ "Tags" ], "responses": { "200": { "description": "Get a company tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateCompanyTag", "summary": "Update a company tag", "tags": [ "Tags" ], "responses": { "200": { "description": "Update a company tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceCompanyTag", "summary": "Replace a company tag", "tags": [ "Tags" ], "responses": { "200": { "description": "Replace a company tag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteCompanyTag", "summary": "Delete a company tag", "tags": [ "Tags" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/feedback": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "post": { "operationId": "createFeedback", "summary": "Submit product feedback", "tags": [ "Feedback" ], "responses": { "201": { "description": "Submit product feedback.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/discover/views": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listDiscoverViews", "summary": "List saved discover views", "tags": [ "Views" ], "responses": { "200": { "description": "List saved discover views.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createDiscoverView", "summary": "Create a saved discover view", "tags": [ "Views" ], "responses": { "201": { "description": "Create a saved discover view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/discover/views/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getDiscoverView", "summary": "Get a saved discover view", "tags": [ "Views" ], "responses": { "200": { "description": "Get a saved discover view.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteDiscoverView", "summary": "Delete a saved discover view", "tags": [ "Views" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/message-templates": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listMessageTemplates", "summary": "List message templates", "tags": [ "Templates" ], "responses": { "200": { "description": "List message templates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createMessageTemplate", "summary": "Create a message template", "tags": [ "Templates" ], "responses": { "201": { "description": "Create a message template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/message-templates/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getMessageTemplate", "summary": "Get a message template", "tags": [ "Templates" ], "responses": { "200": { "description": "Get a message template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateMessageTemplate", "summary": "Update a message template", "tags": [ "Templates" ], "responses": { "200": { "description": "Update a message template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceMessageTemplate", "summary": "Replace a message template", "tags": [ "Templates" ], "responses": { "200": { "description": "Replace a message template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteMessageTemplate", "summary": "Delete a message template", "tags": [ "Templates" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/messages": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listMessages", "summary": "List messages", "tags": [ "Messages" ], "responses": { "200": { "description": "List outgoing messages and incoming replies.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createMessage", "summary": "Send a one-off message", "tags": [ "Messages" ], "responses": { "201": { "description": "Send a one-off message.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/webhooks": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listWebhooks", "summary": "List webhooks", "tags": [ "Webhooks" ], "responses": { "200": { "description": "List webhooks.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createWebhook", "summary": "Create a webhook", "tags": [ "Webhooks" ], "responses": { "201": { "description": "Create a webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteWebhooksCollection", "summary": "Delete webhooks by identifier (legacy)", "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "query", "description": "Webhook identifier. The legacy collection delete takes it as a query or body param.", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/webhooks/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getWebhook", "summary": "Get a webhook", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Get a webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateWebhook", "summary": "Update a webhook", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Update a webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceWebhook", "summary": "Replace a webhook", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Replace a webhook.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteWebhook", "summary": "Delete a webhook", "tags": [ "Webhooks" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/api-keys": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" } ], "get": { "operationId": "listApiKeys", "summary": "List API keys", "tags": [ "API Keys" ], "security": [ { "apiKeyQuery": [] }, { "apiKeyHeader": [] } ], "responses": { "200": { "description": "List API keys.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createApiKey", "summary": "Create an API key", "tags": [ "API Keys" ], "security": [ { "apiKeyQuery": [] }, { "apiKeyHeader": [] } ], "responses": { "201": { "description": "Create an API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/api-keys/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "patch": { "operationId": "updateApiKey", "summary": "Update an API key", "tags": [ "API Keys" ], "security": [ { "apiKeyQuery": [] }, { "apiKeyHeader": [] } ], "responses": { "200": { "description": "Update an API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "put": { "operationId": "replaceApiKey", "summary": "Replace an API key", "tags": [ "API Keys" ], "security": [ { "apiKeyQuery": [] }, { "apiKeyHeader": [] } ], "responses": { "200": { "description": "Replace an API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteApiKey", "summary": "Delete an API key", "tags": [ "API Keys" ], "security": [ { "apiKeyQuery": [] }, { "apiKeyHeader": [] } ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/admin/users/{id}": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "get": { "operationId": "getAdminUser", "summary": "Get a user (admin)", "tags": [ "Admin" ], "responses": { "200": { "description": "Get a user (admin).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generic_resource_response" } } } }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/admin/users/{id}/avatar": { "parameters": [ { "$ref": "#/components/parameters/ApiKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "delete": { "operationId": "deleteAdminUserAvatar", "summary": "Delete a user avatar (admin)", "tags": [ "Admin" ], "responses": { "204": { "description": "No content." }, "401": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } } }, "components": { "securitySchemes": { "apiKeyQuery": { "type": "apiKey", "in": "query", "name": "api_key" }, "apiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-KEY" }, "bearerAuth": { "type": "http", "scheme": "bearer" } }, "parameters": { "ApiKey": { "name": "api_key", "in": "query", "description": "Hunter API key. Prefer the X-API-KEY header outside browser links.", "schema": { "type": "string" } }, "Limit": { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 } }, "Offset": { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, "ClearbitFormat": { "name": "clearbit_format", "in": "query", "description": "When set to any non-empty value, return the Clearbit-compatible response shape.", "schema": { "type": "string", "example": "true" } } }, "responses": { "Error": { "description": "The request could not be completed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_response" } } } } }, "schemas": { "discover_organization_filter": { "type": "object", "additionalProperties": false, "properties": { "domain": { "type": "array", "items": { "type": "string" } }, "name": { "type": "array", "items": { "type": "string" } } } }, "discover_similar_to_filter": { "type": "object", "additionalProperties": false, "properties": { "domain": { "type": "string" }, "organization": { "type": "string" } } }, "location_filter_item": { "type": "object", "additionalProperties": false, "properties": { "continent": { "type": "string" }, "business_region": { "type": "string" }, "country": { "type": "string", "minLength": 2, "maxLength": 2 }, "state": { "type": "string" }, "city": { "type": "string" } } }, "location_filter_collection": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/location_filter_item" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/location_filter_item" } } ] }, "location_filter": { "type": "object", "additionalProperties": false, "properties": { "include": { "$ref": "#/components/schemas/location_filter_collection" }, "exclude": { "$ref": "#/components/schemas/location_filter_collection" } } }, "discover_string_collection_filter": { "type": "object", "additionalProperties": false, "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "discover_year_founded_filter": { "type": "object", "additionalProperties": false, "properties": { "include": { "type": "array", "items": { "type": "integer", "minimum": 1000, "maximum": 9999 } }, "exclude": { "type": "array", "items": { "type": "integer", "minimum": 1000, "maximum": 9999 } }, "from": { "type": "integer", "minimum": 1000, "maximum": 9999 }, "to": { "type": "integer", "minimum": 1000, "maximum": 9999 } } }, "discover_match_filter": { "type": "object", "additionalProperties": false, "properties": { "match": { "type": "string", "enum": [ "all", "any" ], "default": "all" }, "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } }, "discover_funding_filter": { "type": "object", "additionalProperties": false, "properties": { "received": { "type": "boolean" }, "series": { "type": "array", "items": { "type": "string", "enum": [ "pre_seed", "seed", "pre_series_a", "series_a", "pre_series_b", "series_b", "pre_series_c", "series_c+", "other" ] } }, "amount": { "type": "object", "additionalProperties": false, "required": [ "from", "to" ], "properties": { "from": { "type": "integer", "minimum": 0 }, "to": { "type": "integer", "minimum": 0 } } }, "date": { "type": "object", "additionalProperties": false, "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" } } } } }, "discover_toggle_boolean": { "description": "Boolean accepted by Discover job-opening toggles. Only true/false and 1/0 (case-insensitive strings). Aliases such as on/yes/y/off/no are rejected with 400, matching Api::Discover::Validations#boolean_literal?.\n", "anyOf": [ { "type": "boolean" }, { "type": "integer", "enum": [ 0, 1 ] }, { "type": "string", "pattern": "^(?:[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]|1|0)$" } ] }, "discover_job_openings_filter": { "type": "object", "additionalProperties": false, "description": "Filter companies by LinkedIn job openings. Department values come from the jobs-index vocabulary (not a frozen enum). Unknown departments return 400.\n", "properties": { "hiring": { "allOf": [ { "$ref": "#/components/schemas/discover_toggle_boolean" } ], "description": "When true, only companies currently hiring." }, "include_closed_roles": { "allOf": [ { "$ref": "#/components/schemas/discover_toggle_boolean" } ], "description": "When true, include closed roles in the openings match." }, "department": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "job_title": { "type": "object", "additionalProperties": false, "properties": { "include": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "exclude": { "type": "array", "maxItems": 100, "items": { "type": "string" } } } }, "posted_date": { "type": "string", "enum": [ "last7d", "last30d", "last90d" ] }, "open_roles": { "type": "object", "additionalProperties": false, "properties": { "from": { "type": "integer", "minimum": 1 }, "to": { "type": "integer", "minimum": 1 } } } } }, "discover_request": { "type": "object", "additionalProperties": false, "properties": { "api_key": { "type": "string" }, "query": { "type": "string", "maxLength": 2000 }, "organization": { "$ref": "#/components/schemas/discover_organization_filter" }, "similar_to": { "$ref": "#/components/schemas/discover_similar_to_filter" }, "headquarters_location": { "$ref": "#/components/schemas/location_filter" }, "industry": { "allOf": [ { "$ref": "#/components/schemas/discover_string_collection_filter" } ], "description": "Industry names to include or exclude." }, "headcount": { "type": "array", "items": { "type": "string", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10001+" ] } }, "company_type": { "allOf": [ { "$ref": "#/components/schemas/discover_string_collection_filter" } ], "description": "Hunter company types to include or exclude." }, "year_founded": { "$ref": "#/components/schemas/discover_year_founded_filter" }, "keywords": { "$ref": "#/components/schemas/discover_match_filter" }, "technology": { "allOf": [ { "$ref": "#/components/schemas/discover_match_filter" } ], "description": "Technology slugs to include or exclude." }, "funding": { "$ref": "#/components/schemas/discover_funding_filter" }, "job_openings": { "$ref": "#/components/schemas/discover_job_openings_filter" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 }, "offset": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } }, "standard_error_response": { "type": "object", "additionalProperties": false, "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "id", "code", "details" ], "properties": { "id": { "type": "string" }, "code": { "type": "integer" }, "details": { "type": "string" } } } } } }, "legacy_error_response": { "type": "object", "additionalProperties": false, "required": [ "error" ], "properties": { "error": {} } }, "error_response": { "oneOf": [ { "$ref": "#/components/schemas/standard_error_response" }, { "$ref": "#/components/schemas/legacy_error_response" } ] }, "nullable_string": { "type": "string", "nullable": true }, "nullable_integer": { "type": "integer", "nullable": true }, "discover_email_counts": { "type": "object", "additionalProperties": false, "required": [ "personal", "generic", "total" ], "properties": { "personal": { "$ref": "#/components/schemas/nullable_integer" }, "generic": { "$ref": "#/components/schemas/nullable_integer" }, "total": { "$ref": "#/components/schemas/nullable_integer" } } }, "discover_company": { "type": "object", "additionalProperties": false, "required": [ "domain", "organization", "emails_count" ], "properties": { "domain": { "type": "string" }, "organization": { "$ref": "#/components/schemas/nullable_string" }, "emails_count": { "$ref": "#/components/schemas/discover_email_counts" }, "description": { "$ref": "#/components/schemas/nullable_string" }, "industry": { "$ref": "#/components/schemas/nullable_string" }, "technologies": { "type": "array", "items": { "type": "string" } }, "country": { "$ref": "#/components/schemas/nullable_string" }, "state": { "$ref": "#/components/schemas/nullable_string" }, "city": { "$ref": "#/components/schemas/nullable_string" }, "headcount": { "$ref": "#/components/schemas/nullable_string" }, "company_type": { "$ref": "#/components/schemas/nullable_string" }, "year_founded": { "$ref": "#/components/schemas/nullable_integer" }, "keywords": { "type": "array", "nullable": true, "items": { "type": "string" } }, "already_saved": { "type": "boolean" } } }, "discover_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/discover_company" } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "results", "limit", "offset", "params", "filters" ], "properties": { "results": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "params": { "type": "object", "additionalProperties": true }, "filters": { "type": "object", "additionalProperties": true }, "permalink": { "$ref": "#/components/schemas/nullable_string" } } } } }, "strict_boolean_filter": { "description": "A boolean filter. Query-string clients may use the documented case-insensitive aliases.", "anyOf": [ { "type": "boolean" }, { "type": "integer", "enum": [ 0, 1 ] }, { "type": "string", "pattern": "^\\s*(?:[Tt][Rr][Uu][Ee]|[Tt]|1|[Oo][Nn]|[Yy][Ee][Ss]|[Yy]|[Ff][Aa][Ll][Ss][Ee]|[Ff]|0|[Oo][Ff][Ff]|[Nn][Oo]|[Nn])\\s*$" } ] }, "source": { "type": "object", "additionalProperties": false, "required": [ "domain", "uri", "extracted_on", "last_seen_on", "still_on_page" ], "properties": { "id": { "type": "integer" }, "domain": { "type": "string" }, "uri": { "type": "string", "format": "uri" }, "extracted_on": { "type": "string", "format": "date" }, "last_seen_on": { "type": "string", "format": "date" }, "still_on_page": { "type": "boolean" } } }, "verification_summary": { "type": "object", "additionalProperties": false, "required": [ "date", "status" ], "properties": { "id": { "$ref": "#/components/schemas/nullable_integer" }, "date": { "$ref": "#/components/schemas/nullable_string" }, "status": { "$ref": "#/components/schemas/nullable_string" } } }, "domain_search_email": { "type": "object", "additionalProperties": false, "required": [ "value", "type", "source_type", "confidence", "sources", "first_name", "last_name", "position", "position_raw", "seniority", "department", "decision_maker", "linkedin", "twitter", "phone_number", "verification" ], "properties": { "id": { "type": "integer" }, "value": { "type": "string", "format": "email" }, "type": { "type": "string", "enum": [ "personal", "generic" ] }, "source_type": { "type": "string", "enum": [ "found", "generated" ] }, "confidence": { "type": "integer" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/source" } }, "first_name": { "$ref": "#/components/schemas/nullable_string" }, "last_name": { "$ref": "#/components/schemas/nullable_string" }, "position": { "$ref": "#/components/schemas/nullable_string" }, "position_raw": { "$ref": "#/components/schemas/nullable_string" }, "seniority": { "$ref": "#/components/schemas/nullable_string" }, "department": { "$ref": "#/components/schemas/nullable_string" }, "decision_maker": { "type": "boolean" }, "linkedin": { "$ref": "#/components/schemas/nullable_string" }, "twitter": { "$ref": "#/components/schemas/nullable_string" }, "phone_number": { "$ref": "#/components/schemas/nullable_string" }, "verification": { "$ref": "#/components/schemas/verification_summary" } } }, "domain_search_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "domain", "disposable", "webmail", "accept_all", "pattern", "organization", "linked_domains", "emails" ], "properties": { "domain": { "$ref": "#/components/schemas/nullable_string" }, "disposable": { "type": "boolean" }, "webmail": { "type": "boolean" }, "accept_all": { "type": "boolean" }, "pattern": { "$ref": "#/components/schemas/nullable_string" }, "organization": { "$ref": "#/components/schemas/nullable_string" }, "linked_domains": { "type": "array", "items": { "type": "string" } }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/domain_search_email" } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "results", "results_approximate", "limit", "offset", "params" ], "properties": { "results": { "type": "integer" }, "results_approximate": { "type": "boolean" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "aggregations": { "type": "object", "additionalProperties": false, "required": [ "departments", "decision_makers", "personal", "generic" ], "properties": { "departments": { "type": "object", "additionalProperties": { "type": "integer" } }, "decision_makers": { "type": "integer" }, "personal": { "type": "integer" }, "generic": { "type": "integer" } } }, "params": { "type": "object", "additionalProperties": false, "required": [ "domain", "company", "type", "seniority", "department", "decision_maker" ], "properties": { "domain": { "$ref": "#/components/schemas/nullable_string" }, "company": { "$ref": "#/components/schemas/nullable_string" }, "type": { "$ref": "#/components/schemas/nullable_string" }, "seniority": { "$ref": "#/components/schemas/nullable_string" }, "department": { "$ref": "#/components/schemas/nullable_string" }, "decision_maker": { "oneOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/nullable_string" } ] } } } } } } }, "domain_search_request": { "type": "object", "additionalProperties": false, "properties": { "api_key": { "type": "string" }, "domain": { "type": "string" }, "company": { "type": "string" }, "type": { "type": "string", "enum": [ "personal", "generic" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 }, "offset": { "type": "integer", "minimum": 0, "default": 0 }, "department": { "type": "string", "description": "Comma-separated department values from Hunter's live position taxonomy (not a frozen enum). `~` matches people with no department. Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_department`).\n", "example": "sales,marketing" }, "source_type": { "type": "string", "enum": [ "found", "generated" ] }, "job_titles": { "type": "string" }, "seniority": { "type": "string", "description": "Comma-separated seniority values from Hunter's live position taxonomy (not a frozen enum). Unknown values are ignored; a list with no remaining valid values returns 400 (`invalid_seniority`).\n", "example": "senior,executive" }, "decision_maker": { "$ref": "#/components/schemas/strict_boolean_filter" }, "required_field": { "type": "string" }, "verification_status": { "type": "string" }, "aggregations": { "type": "boolean" }, "saved_leads": { "type": "boolean" }, "location": { "$ref": "#/components/schemas/location_filter" } } }, "nullable_boolean": { "type": "boolean", "nullable": true }, "email_finder_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "email", "score", "domain", "accept_all", "position", "twitter", "linkedin_url", "phone_number", "company", "source_type", "sources", "verification" ], "properties": { "first_name": { "$ref": "#/components/schemas/nullable_string" }, "last_name": { "$ref": "#/components/schemas/nullable_string" }, "email": { "$ref": "#/components/schemas/nullable_string" }, "score": { "$ref": "#/components/schemas/nullable_integer" }, "domain": { "$ref": "#/components/schemas/nullable_string" }, "accept_all": { "$ref": "#/components/schemas/nullable_boolean" }, "position": { "$ref": "#/components/schemas/nullable_string" }, "twitter": { "$ref": "#/components/schemas/nullable_string" }, "linkedin_url": { "$ref": "#/components/schemas/nullable_string" }, "phone_number": { "$ref": "#/components/schemas/nullable_string" }, "company": { "$ref": "#/components/schemas/nullable_string" }, "source_type": { "$ref": "#/components/schemas/nullable_string" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/source" } }, "verification": { "$ref": "#/components/schemas/verification_summary" } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "params" ], "properties": { "params": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "full_name", "domain", "company", "linkedin_handle", "max_duration" ], "properties": { "first_name": { "$ref": "#/components/schemas/nullable_string" }, "last_name": { "$ref": "#/components/schemas/nullable_string" }, "full_name": { "$ref": "#/components/schemas/nullable_string" }, "domain": { "$ref": "#/components/schemas/nullable_string" }, "company": { "$ref": "#/components/schemas/nullable_string" }, "linkedin_handle": { "$ref": "#/components/schemas/nullable_string" }, "max_duration": { "$ref": "#/components/schemas/nullable_string" } } } } } } }, "email_verifier_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "status", "score", "email", "regexp", "gibberish", "disposable", "webmail", "mx_records", "smtp_server", "smtp_check", "accept_all", "block", "sources", "result", "_deprecation_notice" ], "properties": { "status": { "type": "string" }, "score": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "regexp": { "type": "boolean" }, "gibberish": { "type": "boolean" }, "disposable": { "type": "boolean" }, "webmail": { "type": "boolean" }, "mx_records": { "type": "boolean" }, "smtp_server": { "type": "boolean" }, "smtp_check": { "type": "boolean" }, "accept_all": { "type": "boolean" }, "block": { "type": "boolean" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/source" } }, "result": { "type": "string" }, "_deprecation_notice": { "type": "string" } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "params" ], "properties": { "domain": { "type": "string" }, "company_name": { "type": "string" }, "following_domain": { "type": "boolean" }, "webmail": { "type": "boolean" }, "params": { "type": "object", "additionalProperties": false, "required": [ "email" ], "properties": { "email": { "type": "string" } } } } } } }, "pending_envelope": { "type": "object", "additionalProperties": false, "required": [ "meta" ], "properties": { "data": { "type": "object", "additionalProperties": false }, "meta": { "type": "object", "additionalProperties": false, "required": [ "params", "message" ], "properties": { "params": { "type": "object", "additionalProperties": false, "required": [ "email" ], "properties": { "email": { "type": "string" } } }, "message": { "type": "string" } } } } }, "email_count_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "total", "personal_emails", "generic_emails", "department", "seniority" ], "properties": { "total": { "type": "integer" }, "personal_emails": { "type": "integer" }, "generic_emails": { "type": "integer" }, "department": { "type": "object", "additionalProperties": { "type": "integer" } }, "seniority": { "type": "object", "additionalProperties": { "type": "integer" } }, "job_titles": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "params" ], "properties": { "params": { "type": "object", "additionalProperties": false, "required": [ "domain", "company", "type" ], "properties": { "domain": { "$ref": "#/components/schemas/nullable_string" }, "company": { "$ref": "#/components/schemas/nullable_string" }, "type": { "$ref": "#/components/schemas/nullable_string" } } } } } } }, "social_handle": { "type": "object", "additionalProperties": false, "required": [ "handle" ], "properties": { "handle": { "$ref": "#/components/schemas/nullable_string" } } }, "person": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "email", "location", "timeZone", "utcOffset", "geo", "bio", "site", "avatar", "employment", "facebook", "github", "twitter", "linkedin", "googleplus", "gravatar", "fuzzy", "emailProvider", "indexedAt", "phone", "activeAt", "inactiveAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "object", "additionalProperties": false, "required": [ "fullName", "givenName", "familyName" ], "properties": { "fullName": { "$ref": "#/components/schemas/nullable_string" }, "givenName": { "$ref": "#/components/schemas/nullable_string" }, "familyName": { "$ref": "#/components/schemas/nullable_string" } } }, "email": { "type": "string", "format": "email" }, "location": { "$ref": "#/components/schemas/nullable_string" }, "timeZone": { "$ref": "#/components/schemas/nullable_string" }, "utcOffset": { "$ref": "#/components/schemas/nullable_integer" }, "geo": { "type": "object", "additionalProperties": false, "required": [ "city", "state", "stateCode", "country", "countryCode", "lat", "lng" ], "properties": { "city": { "$ref": "#/components/schemas/nullable_string" }, "state": { "$ref": "#/components/schemas/nullable_string" }, "stateCode": { "$ref": "#/components/schemas/nullable_string" }, "country": { "$ref": "#/components/schemas/nullable_string" }, "countryCode": { "$ref": "#/components/schemas/nullable_string" }, "lat": { "type": "number", "nullable": true }, "lng": { "type": "number", "nullable": true } } }, "bio": { "$ref": "#/components/schemas/nullable_string" }, "site": { "$ref": "#/components/schemas/nullable_string" }, "avatar": { "$ref": "#/components/schemas/nullable_string" }, "employment": { "type": "object", "additionalProperties": false, "required": [ "domain", "name", "title", "role", "subRole", "seniority" ], "properties": { "domain": { "$ref": "#/components/schemas/nullable_string" }, "name": { "$ref": "#/components/schemas/nullable_string" }, "title": { "$ref": "#/components/schemas/nullable_string" }, "role": { "$ref": "#/components/schemas/nullable_string" }, "subRole": { "$ref": "#/components/schemas/nullable_string" }, "seniority": { "$ref": "#/components/schemas/nullable_string" } } }, "facebook": { "$ref": "#/components/schemas/social_handle" }, "github": { "type": "object", "additionalProperties": false, "required": [ "handle", "id", "avatar", "company", "blog", "followers", "following" ], "properties": { "handle": { "$ref": "#/components/schemas/nullable_string" }, "id": { "$ref": "#/components/schemas/nullable_string" }, "avatar": { "$ref": "#/components/schemas/nullable_string" }, "company": { "$ref": "#/components/schemas/nullable_string" }, "blog": { "$ref": "#/components/schemas/nullable_string" }, "followers": { "$ref": "#/components/schemas/nullable_integer" }, "following": { "$ref": "#/components/schemas/nullable_integer" } } }, "twitter": { "type": "object", "additionalProperties": false, "required": [ "handle", "id", "bio", "followers", "following", "statuses", "favorites", "location", "site", "avatar" ], "properties": { "handle": { "$ref": "#/components/schemas/nullable_string" }, "id": { "$ref": "#/components/schemas/nullable_string" }, "bio": { "$ref": "#/components/schemas/nullable_string" }, "followers": { "$ref": "#/components/schemas/nullable_integer" }, "following": { "$ref": "#/components/schemas/nullable_integer" }, "statuses": { "$ref": "#/components/schemas/nullable_integer" }, "favorites": { "$ref": "#/components/schemas/nullable_integer" }, "location": { "$ref": "#/components/schemas/nullable_string" }, "site": { "$ref": "#/components/schemas/nullable_string" }, "avatar": { "$ref": "#/components/schemas/nullable_string" } } }, "linkedin": { "$ref": "#/components/schemas/social_handle" }, "googleplus": { "$ref": "#/components/schemas/social_handle" }, "gravatar": { "type": "object", "additionalProperties": false, "required": [ "handle", "urls", "avatar", "avatars" ], "properties": { "handle": { "$ref": "#/components/schemas/nullable_string" }, "urls": { "type": "array", "items": { "type": "string" } }, "avatar": { "$ref": "#/components/schemas/nullable_string" }, "avatars": { "type": "array", "items": { "type": "string" } } } }, "fuzzy": { "type": "boolean" }, "emailProvider": { "$ref": "#/components/schemas/nullable_string" }, "indexedAt": { "$ref": "#/components/schemas/nullable_string" }, "phone": { "$ref": "#/components/schemas/nullable_string" }, "activeAt": { "$ref": "#/components/schemas/nullable_string" }, "inactiveAt": { "$ref": "#/components/schemas/nullable_string" } } }, "person_enrichment_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/person" }, "meta": { "type": "object", "additionalProperties": false, "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } } } } }, "company_facebook": { "type": "object", "additionalProperties": false, "required": [ "handle", "likes" ], "properties": { "handle": { "$ref": "#/components/schemas/nullable_string" }, "likes": { "$ref": "#/components/schemas/nullable_integer" } } }, "company": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "legalName", "domain", "domainAliases", "site", "category", "tags", "description", "foundedYear", "location", "timeZone", "utcOffset", "geo", "logo", "facebook", "linkedin", "twitter", "crunchbase", "youtube", "instagram", "emailProvider", "type", "companyType", "ticker", "identifiers", "phone", "metrics", "indexedAt", "tech", "techCategories", "fundingRounds", "parent", "ultimateParent" ], "properties": { "id": { "type": "string" }, "name": { "$ref": "#/components/schemas/nullable_string" }, "legalName": { "$ref": "#/components/schemas/nullable_string" }, "domain": { "type": "string" }, "domainAliases": { "type": "array", "items": { "type": "string" } }, "site": { "type": "object", "additionalProperties": false, "required": [ "phoneNumbers", "emailAddresses" ], "properties": { "phoneNumbers": { "type": "array", "items": { "type": "string" } }, "emailAddresses": { "type": "array", "items": { "type": "string", "format": "email" } } } }, "category": { "type": "object", "additionalProperties": false, "required": [ "sector", "industryGroup", "industry", "subIndustry", "gicsCode", "sicCode", "sic4Codes", "naicsCode", "naics6Codes", "naics6Codes2022" ], "properties": { "sector": { "$ref": "#/components/schemas/nullable_string" }, "industryGroup": { "$ref": "#/components/schemas/nullable_string" }, "industry": { "$ref": "#/components/schemas/nullable_string" }, "subIndustry": { "$ref": "#/components/schemas/nullable_string" }, "gicsCode": { "$ref": "#/components/schemas/nullable_string" }, "sicCode": { "$ref": "#/components/schemas/nullable_string" }, "sic4Codes": { "type": "array", "items": { "type": "string" } }, "naicsCode": { "$ref": "#/components/schemas/nullable_string" }, "naics6Codes": { "type": "array", "items": { "type": "string" } }, "naics6Codes2022": { "type": "array", "items": { "type": "string" } } } }, "tags": { "type": "array", "nullable": true, "items": { "type": "string" } }, "description": { "$ref": "#/components/schemas/nullable_string" }, "foundedYear": { "$ref": "#/components/schemas/nullable_integer" }, "location": { "$ref": "#/components/schemas/nullable_string" }, "timeZone": { "$ref": "#/components/schemas/nullable_string" }, "utcOffset": { "$ref": "#/components/schemas/nullable_integer" }, "geo": { "type": "object", "additionalProperties": false, "required": [ "streetNumber", "streetName", "subPremise", "streetAddress", "city", "postalCode", "state", "stateCode", "country", "countryCode", "lat", "lng" ], "properties": { "streetNumber": { "$ref": "#/components/schemas/nullable_string" }, "streetName": { "$ref": "#/components/schemas/nullable_string" }, "subPremise": { "$ref": "#/components/schemas/nullable_string" }, "streetAddress": { "$ref": "#/components/schemas/nullable_string" }, "city": { "$ref": "#/components/schemas/nullable_string" }, "postalCode": { "$ref": "#/components/schemas/nullable_string" }, "state": { "$ref": "#/components/schemas/nullable_string" }, "stateCode": { "$ref": "#/components/schemas/nullable_string" }, "country": { "$ref": "#/components/schemas/nullable_string" }, "countryCode": { "$ref": "#/components/schemas/nullable_string" }, "lat": { "type": "number", "nullable": true }, "lng": { "type": "number", "nullable": true } } }, "logo": { "type": "string", "format": "uri" }, "facebook": { "$ref": "#/components/schemas/company_facebook" }, "linkedin": { "$ref": "#/components/schemas/social_handle" }, "twitter": { "type": "object", "additionalProperties": false, "required": [ "handle", "id", "bio", "followers", "following", "location", "site", "avatar" ], "properties": { "handle": { "$ref": "#/components/schemas/nullable_string" }, "id": { "$ref": "#/components/schemas/nullable_string" }, "bio": { "$ref": "#/components/schemas/nullable_string" }, "followers": { "$ref": "#/components/schemas/nullable_integer" }, "following": { "$ref": "#/components/schemas/nullable_integer" }, "location": { "$ref": "#/components/schemas/nullable_string" }, "site": { "$ref": "#/components/schemas/nullable_string" }, "avatar": { "$ref": "#/components/schemas/nullable_string" } } }, "crunchbase": { "$ref": "#/components/schemas/social_handle" }, "youtube": { "$ref": "#/components/schemas/social_handle" }, "instagram": { "$ref": "#/components/schemas/social_handle" }, "emailsCount": { "$ref": "#/components/schemas/discover_email_counts" }, "emailProvider": { "$ref": "#/components/schemas/nullable_string" }, "type": { "$ref": "#/components/schemas/nullable_string" }, "companyType": { "$ref": "#/components/schemas/nullable_string" }, "ticker": { "$ref": "#/components/schemas/nullable_string" }, "identifiers": { "type": "object", "additionalProperties": false, "required": [ "usEIN" ], "properties": { "usEIN": { "$ref": "#/components/schemas/nullable_string" } } }, "phone": { "$ref": "#/components/schemas/nullable_string" }, "metrics": { "type": "object", "additionalProperties": false, "required": [ "alexaUsRank", "alexaGlobalRank", "trafficRank", "employees", "employeesCount", "marketCap", "raised", "annualRevenue", "estimatedAnnualRevenue", "fiscalYearEnd" ], "properties": { "alexaUsRank": { "$ref": "#/components/schemas/nullable_integer" }, "alexaGlobalRank": { "$ref": "#/components/schemas/nullable_integer" }, "trafficRank": { "$ref": "#/components/schemas/nullable_integer" }, "employees": { "$ref": "#/components/schemas/nullable_string" }, "employeesCount": { "$ref": "#/components/schemas/nullable_integer" }, "marketCap": { "$ref": "#/components/schemas/nullable_integer" }, "raised": { "type": "number", "nullable": true }, "annualRevenue": { "$ref": "#/components/schemas/nullable_integer" }, "estimatedAnnualRevenue": { "$ref": "#/components/schemas/nullable_integer" }, "fiscalYearEnd": { "$ref": "#/components/schemas/nullable_string" } } }, "indexedAt": { "$ref": "#/components/schemas/nullable_string" }, "tech": { "type": "array", "items": { "type": "string" } }, "techCategories": { "type": "array", "items": { "type": "string" } }, "fundingRounds": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "date", "type", "amount", "investors" ], "properties": { "date": { "type": "string", "format": "date" }, "type": { "$ref": "#/components/schemas/nullable_string" }, "amount": { "type": "string" }, "investors": { "type": "array", "items": { "type": "string" } } } } }, "alreadySaved": { "type": "boolean" }, "parent": { "type": "object", "additionalProperties": false, "required": [ "domain" ], "properties": { "domain": { "$ref": "#/components/schemas/nullable_string" } } }, "ultimateParent": { "type": "object", "additionalProperties": false, "required": [ "domain" ], "properties": { "domain": { "$ref": "#/components/schemas/nullable_string" } } } } }, "company_enrichment_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "$ref": "#/components/schemas/company" }, "meta": { "type": "object", "additionalProperties": false, "required": [ "domain" ], "properties": { "domain": { "type": "string" } } } } }, "combined_enrichment_response": { "type": "object", "additionalProperties": false, "required": [ "data", "meta" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "person", "company" ], "properties": { "person": { "$ref": "#/components/schemas/person" }, "company": { "$ref": "#/components/schemas/company" } } }, "meta": { "type": "object", "additionalProperties": false, "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } } } } }, "combined_clearbit_response": { "type": "object", "additionalProperties": false, "required": [ "person", "company" ], "properties": { "person": { "$ref": "#/components/schemas/person" }, "company": { "$ref": "#/components/schemas/company" } } }, "usage_bucket": { "type": "object", "additionalProperties": false, "required": [ "used", "available", "remaining" ], "properties": { "used": { "type": "number" }, "available": { "type": "number" }, "remaining": { "type": "number" }, "over_quota": { "type": "number" } } }, "account_response": { "type": "object", "additionalProperties": false, "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": false, "required": [ "first_name", "last_name", "email", "plan_name", "plan_level", "reset_date", "team_id", "requests", "calls" ], "properties": { "first_name": { "$ref": "#/components/schemas/nullable_string" }, "last_name": { "$ref": "#/components/schemas/nullable_string" }, "email": { "type": "string", "format": "email" }, "plan_name": { "type": "string" }, "plan_level": { "type": "integer" }, "reset_date": { "type": "string", "format": "date" }, "team_id": { "type": "integer" }, "requests": { "type": "object", "additionalProperties": false, "required": [ "searches", "verifications" ], "properties": { "credits": { "$ref": "#/components/schemas/usage_bucket" }, "searches": { "$ref": "#/components/schemas/usage_bucket" }, "verifications": { "$ref": "#/components/schemas/usage_bucket" } } }, "calls": { "type": "object", "additionalProperties": false, "required": [ "_deprecation_notice", "used", "available" ], "properties": { "_deprecation_notice": { "type": "string" }, "used": { "type": "number" }, "available": { "type": "number" } } } } } } }, "generic_resource_response": { "type": "object", "additionalProperties": true, "description": "Generic envelope for V2 resource operations whose detailed schema is not yet in the contract." }, "domain_finder_request": { "type": "object", "additionalProperties": true, "required": [ "company" ], "properties": { "company": { "type": "string", "description": "Company name to resolve to a domain." }, "limit": { "type": "integer", "description": "Maximum suggestions to return." }, "perfect_match": { "type": "boolean", "description": "Only return an exact company-name match." } } } } } }