> ## Documentation Index
> Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview leads from supersearch

> Preview the leads matching a SuperSearch query without enriching them


Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`



## OpenAPI

````yaml https://api.instantly.ai/openapi/api_v2.json post /api/v2/supersearch-enrichment/preview-leads-from-supersearch
openapi: 3.1.0
info:
  title: API Explorer
  description: >-
    The entire API V2 documentation is interactive and can be tested here. To
    the right side of every endpoint you will see a box with an example request.
    You can click on the "Try it" button to send a request to the server right
    from the docs. You will need to provide an API key by clicking the
    `ApiKeyAuth_token` blue text.
  version: 2.0.0
servers:
  - url: https://api.instantly.ai
    description: Instantly API Server
security:
  - ApiKeyAuth: []
tags:
  - name: Analytics
    description: Endpoints related to analytics
    x-displayName: Analytics
  - name: OAuth
    description: >-
      OAuth authentication endpoints for connecting Google and Microsoft email
      accounts
    x-displayName: OAuth
  - name: Account
    description: An email account that can be used to send campaigns
    x-displayName: Account
  - name: Campaign
    description: A campaign that can be sent to a list of recipients
    x-displayName: Campaign
  - name: Email
    description: >-
      A campaign email, a reply, a manually sent email, or any other email
      that's visible in the Unibox
    x-displayName: Email
  - name: EmailVerification
    description: A single email verification
    x-displayName: Email Verification
  - name: LeadList
    description: A list used to store leads
    x-displayName: Lead List
  - name: InboxPlacementTest
    description: An inbox placement test
    x-displayName: Inbox Placement Test
  - name: InboxPlacementAnalytics
    description: Analytics data for individual emails in inbox placement tests
    x-displayName: Inbox Placement Analytics
  - name: InboxPlacementBlacklist&SpamAssassinReport
    description: Report data for an inbox placement test
    x-displayName: Inbox Placement Blacklist & SpamAssassin Report
  - name: APIKey
    description: API Key
    x-displayName: API Key
  - name: AccountCampaignMapping
    description: Account Campaign Mapping
    x-displayName: Account Campaign Mapping
  - name: Lead
    description: A lead entity representing an individual lead
    x-displayName: Lead
  - name: BackgroundJob
    description: A background job that can be used to perform long-running tasks
    x-displayName: Background Job
  - name: CustomTag
    description: >-
      A custom tag for organizing and categorizing accounts and campaigns. You
      can use them as filters in apis that list accounts and campaigns.
    x-displayName: Custom Tag
  - name: CustomTagMapping
    description: >-
      This entity represents a tag being assigned to a specific campaign or
      email account. When an email account is assigned a tag, a new custom tag
      mapping entry is created, which connects the tag (`tag_id` field) with the
      email account (`resource_id` field). You can use it to see which tag si
      connected to which resource.
    x-displayName: Custom Tag Mapping
  - name: BlockListEntry
    description: A blocked email or domain
    x-displayName: Block List Entry
  - name: LeadLabel
    description: A custom label for categorizing and managing leads
    x-displayName: Lead Label
  - name: Workspace
    description: A workspace entity representing a workspace
    x-displayName: Workspace
  - name: SuperSearchEnrichment
    description: >-
      An enrichment can take different forms, such as email enrichment or
      LinkedIn enrichment. Leads may be imported from SuperSearch using the
      dedicated endpoint, or enriched directly within a list or campaign by
      attaching an enrichment to it.
    x-displayName: SuperSearch Enrichment
  - name: WorkspaceGroupMember
    description: >-
      A member of a workspace group. You can use the endpoints within this
      entity to manage the members of a workspace group.
    x-displayName: Workspace Group Member
  - name: WorkspaceMember
    description: A member of a workspace with associated user details
    x-displayName: Workspace Member
  - name: CampaignSubsequence
    description: A subsequence entity representing a follow-up sequence
    x-displayName: Campaign Subsequence
  - name: AuditLog
    description: Audit log records for tracking system activities
    x-displayName: Audit Log
  - name: Webhook
    description: A webhook subscription for receiving event notifications
    x-displayName: Webhook
  - name: WebhookEvent
    description: A webhook event that was sent or attempted to be sent
    x-displayName: Webhook Event
  - name: DFYEmailAccountOrder
    description: A Done-For-You email account order
    x-displayName: DFY Email Account Order
  - name: CustomPromptTemplate
    description: Custom prompt templates for creating custom prompts
    x-displayName: Custom Prompt Template
  - name: SalesFlow
    description: >-
      Manages how sales users view and interact with campaign and lead lists
      within the sales flow.
    x-displayName: Sales Flow
  - name: EmailTemplate
    description: A campaign email template
    x-displayName: Email Template
  - name: WorkspaceBilling
    description: Workspace Billing
    x-displayName: Workspace Billing
  - name: CRMActions
    description: CRM related actions
    x-displayName: CRM Actions
paths:
  /api/v2/supersearch-enrichment/preview-leads-from-supersearch:
    post:
      tags:
        - SuperSearchEnrichment
      summary: Preview leads from supersearch
      description: >-
        Preview the leads matching a SuperSearch query without enriching them



        Requires one of the following scopes: `supersearch_enrichments:read`,
        `supersearch_enrichments:all`, `all:read`, `all:all`
      operationId: previewLeadsFromSupersearch
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - search_filters
              properties:
                search_filters:
                  type: object
                  description: Search filters to find leads.
                  properties:
                    locations:
                      oneOf:
                        - type: array
                          description: >-
                            Legacy format: Array of locations to include in the
                            search. For new integrations, use the object format
                            with include/exclude properties.
                          items:
                            oneOf:
                              - type: object
                                properties:
                                  place_id:
                                    type: string
                                    description: >-
                                      Google Maps Place ID of the lead's
                                      location
                                      (https://developers.google.com/maps/documentation/places/web-service/place-id)
                                    example: ChIJN1t_t3uEmsRUso9K6W47H4
                                  label:
                                    type: string
                                    description: Label of the lead's location
                                    example: San Francisco, CA, USA
                                required:
                                  - place_id
                                additionalProperties: false
                              - type: object
                                properties:
                                  city:
                                    type: string
                                    description: City of the lead
                                    example: San Francisco
                                  state:
                                    type: string
                                    description: State of the lead
                                    example: California
                                  country:
                                    type: string
                                    description: Country of the lead
                                    example: United States
                                anyOf:
                                  - required:
                                      - city
                                  - required:
                                      - state
                                  - required:
                                      - country
                                additionalProperties: false
                        - type: object
                          description: Locations to include or exclude in the search
                          properties:
                            include:
                              type: array
                              items:
                                oneOf:
                                  - type: object
                                    properties:
                                      place_id:
                                        type: string
                                        description: >-
                                          Google Maps Place ID of the lead's
                                          location
                                          (https://developers.google.com/maps/documentation/places/web-service/place-id)
                                        example: ChIJN1t_t3uEmsRUso9K6W47H4
                                      label:
                                        type: string
                                        description: Label of the lead's location
                                        example: San Francisco, CA, USA
                                    required:
                                      - place_id
                                    additionalProperties: false
                                  - type: object
                                    properties:
                                      city:
                                        type: string
                                        description: City of the lead
                                        example: San Francisco
                                      state:
                                        type: string
                                        description: State of the lead
                                        example: California
                                      country:
                                        type: string
                                        description: Country of the lead
                                        example: United States
                                    anyOf:
                                      - required:
                                          - city
                                      - required:
                                          - state
                                      - required:
                                          - country
                                    additionalProperties: false
                              description: Locations to include in the search
                            exclude:
                              type: array
                              items:
                                oneOf:
                                  - type: object
                                    properties:
                                      place_id:
                                        type: string
                                        description: >-
                                          Google Maps Place ID of the lead's
                                          location
                                          (https://developers.google.com/maps/documentation/places/web-service/place-id)
                                        example: ChIJN1t_t3uEmsRUso9K6W47H4
                                      label:
                                        type: string
                                        description: Label of the lead's location
                                        example: San Francisco, CA, USA
                                    required:
                                      - place_id
                                    additionalProperties: false
                                  - type: object
                                    properties:
                                      city:
                                        type: string
                                        description: City of the lead
                                        example: San Francisco
                                      state:
                                        type: string
                                        description: State of the lead
                                        example: California
                                      country:
                                        type: string
                                        description: Country of the lead
                                        example: United States
                                    anyOf:
                                      - required:
                                          - city
                                      - required:
                                          - state
                                      - required:
                                          - country
                                    additionalProperties: false
                              description: Locations to exclude from the search
                    department:
                      type: array
                      items:
                        type: string
                        enum:
                          - Engineering
                          - Finance & Administration
                          - Human Resources
                          - IT & IS
                          - Marketing
                          - Operations
                          - Sales
                          - Support
                          - Other
                        x-enumDescriptions:
                          Engineering: Engineering
                          Finance & Administration: Finance & Administration
                          Human Resources: Human Resources
                          IT & IS: IT & IS
                          Marketing: Marketing
                          Operations: Operations
                          Sales: Sales
                          Support: Support
                          Other: Other
                        description: Department of the lead
                        example: Engineering
                    level:
                      type: array
                      items:
                        type: string
                        enum:
                          - C-Level
                          - VP-Level
                          - Director-Level
                          - Manager-Level
                          - Staff
                          - Entry level
                          - Mid-Senior level
                          - Director
                          - Associate
                          - Owner
                          - Executive
                          - Manager
                          - Senior
                          - Chief X Officer (CxO)
                          - Internship
                          - Vice President (VP)
                          - Unpaid / Internship
                          - Partner
                        x-enumDescriptions:
                          C-Level: C-Level
                          VP-Level: VP-Level
                          Director-Level: Director-Level
                          Manager-Level: Manager-Level
                          Staff: Staff
                          Entry level: Entry level
                          Mid-Senior level: Mid-Senior level
                          Director: Director
                          Associate: Associate
                          Owner: Owner
                          Executive: Executive
                          Manager: Manager
                          Senior: Senior
                          Chief X Officer (CxO): Chief X Officer (CxO)
                          Internship: Internship
                          Vice President (VP): Vice President (VP)
                          Unpaid / Internship: Unpaid / Internship
                          Partner: Partner
                        description: Level of the lead
                        example: Entry level
                    employeeCount:
                      type: array
                      description: Employee count filters.
                      items:
                        oneOf:
                          - type: string
                            enum:
                              - 0 - 25
                              - 25 - 100
                              - 100 - 250
                              - 250 - 1000
                              - 1K - 10K
                              - 10K - 50K
                              - 50K - 100K
                              - '> 100K'
                            description: 'Legacy format: Predefined employee count range'
                            x-enumDescriptions:
                              0 - 25: 0 - 25
                              25 - 100: 25 - 100
                              100 - 250: 100 - 250
                              250 - 1000: 250 - 1000
                              1K - 10K: 1K - 10K
                              10K - 50K: 10K - 50K
                              50K - 100K: 50K - 100K
                              '> 100K': '> 100K'
                            example: 0 - 25
                          - type: object
                            description: Custom employee count range
                            properties:
                              op:
                                type: string
                                description: Operation type.
                                example: between
                              min:
                                type: number
                                description: >-
                                  Minimum employee count (inclusive), used for
                                  "between" and "gte" operations
                                example: 50
                              max:
                                type: number
                                description: >-
                                  Maximum employee count (inclusive), used for
                                  "between" and "lte" operations
                                example: 200
                            required:
                              - op
                            additionalProperties: false
                    revenue:
                      type: array
                      items:
                        type: string
                        enum:
                          - $0 - 1M
                          - $1 - 10M
                          - $10 - 50M
                          - $50 - 100M
                          - $100 - 250M
                          - $250 - 500M
                          - $500M - 1B
                          - '> $1B'
                        x-enumDescriptions:
                          $0 - 1M: $0 - 1M
                          $1 - 10M: $1M - 10M
                          $10 - 50M: $10M - 50M
                          $50 - 100M: $50M - 100M
                          $100 - 250M: $100M - 250M
                          $250 - 500M: $250M - 500M
                          $500M - 1B: $500M - 1B
                          '> $1B': '> $1B'
                        description: Revenue of the lead company
                        example: $1 - 10M
                    news:
                      type: array
                      items:
                        type: string
                        enum:
                          - launches
                          - expands_offices_to
                          - hires
                          - partners_with
                          - leaves
                          - receives_financing
                          - recognized_as
                          - closes_offices_in
                          - is_developing
                          - has_issues_with
                          - promotes
                          - opens_new_location
                          - receives_award
                          - acquires
                          - invests_into_assets
                          - signs_new_client
                          - increases_headcount_by
                          - retires_from
                          - invests_into
                          - integrates_with
                          - expands_facilities
                          - goes_public
                          - sells_assets_to
                          - identified_as_competitor_of
                          - decreases_headcount_by
                          - expands_offices_in
                          - files_suit_against
                          - merges_with
                        x-enumDescriptions:
                          launches: Launches
                          expands_offices_to: Expands Offices To
                          hires: Hires
                          partners_with: Partners With
                          leaves: Leaves
                          receives_financing: Receives Financing
                          recognized_as: Recognized As
                          closes_offices_in: Closes Offices In
                          is_developing: Is Developing
                          has_issues_with: Has Issues With
                          promotes: Promotes
                          opens_new_location: Opens New Location
                          receives_award: Receives Award
                          acquires: Acquires
                          invests_into_assets: Invests Into Assets
                          signs_new_client: Signs New Client
                          increases_headcount_by: Increases Headcount By
                          retires_from: Retires From
                          invests_into: Invests Into
                          integrates_with: Integrates With
                          expands_facilities: Expands Facilities
                          goes_public: Goes Public
                          sells_assets_to: Sells Assets To
                          identified_as_competitor_of: Identified As Competitor Of
                          decreases_headcount_by: Decreases Headcount By
                          expands_offices_in: Expands Offices In
                          files_suit_against: Files Suit Against
                          merges_with: Merges With
                        description: News about the lead company
                        example: launches
                    title:
                      type: object
                      properties:
                        include:
                          type: array
                          items:
                            type: string
                            example: CEO
                          description: Titles of the lead to include in the search
                        exclude:
                          type: array
                          items:
                            type: string
                            example: VP
                          description: Titles of the lead to exclude in the search
                    name:
                      type: array
                      items:
                        type: string
                        example: John Doe
                      description: Names of the lead to include in the search
                    company_name:
                      type: object
                      properties:
                        include:
                          type: array
                          items:
                            type: string
                            example: Google
                          description: Companies of the lead to include in the search
                        exclude:
                          type: array
                          items:
                            type: string
                            example: Amazon
                          description: Companies of the lead to exclude in the search
                    look_alike:
                      type: string
                      description: >-
                        If set, the lead finder will find companies that are
                        similar to the look-alike domain
                      example: google.com
                    keyword_filter:
                      type: object
                      properties:
                        exclude:
                          type: string
                          example: sales
                        include:
                          type: string
                          example: marketing
                    industry:
                      type: object
                      properties:
                        exclude:
                          type: array
                          items:
                            type: string
                            enum:
                              - Agriculture & Mining
                              - Business Services
                              - Computers & Electronics
                              - Consumer Services
                              - Education
                              - Energy & Utilities
                              - Financial Services
                              - Government
                              - Healthcare, Pharmaceuticals, & Biotech
                              - Manufacturing
                              - Media & Entertainment
                              - Non-Profit
                              - Other
                              - Real Estate & Construction
                              - Retail
                              - Software & Internet
                              - Telecommunications
                              - Transportation & Storage
                              - Travel, Recreation, and Leisure
                              - Wholesale & Distribution
                            x-enumDescriptions:
                              Agriculture & Mining: Agriculture & Mining
                              Business Services: Business Services
                              Financial Services: Financial Services
                              Computers & Electronics: Computers & Electronics
                              Consumer Services: Consumer Services
                              Education: Education
                              Energy & Utilities: Energy & Utilities
                              Healthcare, Pharmaceuticals, & Biotech: Healthcare, Pharmaceuticals, & Biotech
                              Manufacturing: Manufacturing
                              Media & Entertainment: Media & Entertainment
                              Non-Profit: Non-Profit
                              Other: Other
                              Real Estate & Construction: Real Estate & Construction
                              Retail: Retail
                              Software & Internet: Software & Internet
                              Telecommunications: Telecommunications
                              Transportation & Storage: Transportation & Storage
                              Travel, Recreation, and Leisure: Travel, Recreation, and Leisure
                              Wholesale & Distribution: Wholesale & Distribution
                              Government: Government
                            example: Agriculture & Mining
                          description: >-
                            Industries of the lead company to exclude in the
                            search
                        include:
                          type: array
                          items:
                            type: string
                            enum:
                              - Agriculture & Mining
                              - Business Services
                              - Computers & Electronics
                              - Consumer Services
                              - Education
                              - Energy & Utilities
                              - Financial Services
                              - Government
                              - Healthcare, Pharmaceuticals, & Biotech
                              - Manufacturing
                              - Media & Entertainment
                              - Non-Profit
                              - Other
                              - Real Estate & Construction
                              - Retail
                              - Software & Internet
                              - Telecommunications
                              - Transportation & Storage
                              - Travel, Recreation, and Leisure
                              - Wholesale & Distribution
                            x-enumDescriptions:
                              Agriculture & Mining: Agriculture & Mining
                              Business Services: Business Services
                              Financial Services: Financial Services
                              Computers & Electronics: Computers & Electronics
                              Consumer Services: Consumer Services
                              Education: Education
                              Energy & Utilities: Energy & Utilities
                              Healthcare, Pharmaceuticals, & Biotech: Healthcare, Pharmaceuticals, & Biotech
                              Manufacturing: Manufacturing
                              Media & Entertainment: Media & Entertainment
                              Non-Profit: Non-Profit
                              Other: Other
                              Real Estate & Construction: Real Estate & Construction
                              Retail: Retail
                              Software & Internet: Software & Internet
                              Telecommunications: Telecommunications
                              Transportation & Storage: Transportation & Storage
                              Travel, Recreation, and Leisure: Travel, Recreation, and Leisure
                              Wholesale & Distribution: Wholesale & Distribution
                              Government: Government
                            description: >-
                              Industries of the lead company to include in the
                              search
                            example: Agriculture & Mining
                    subIndustry:
                      type: object
                      properties:
                        exclude:
                          type: array
                          items:
                            type: string
                            enum:
                              - Dairy
                              - Farming
                              - Fishery
                              - Food & Beverages
                              - Food Production
                              - Mining & Metals
                              - Paper & Forest Products
                              - Ranching
                              - Tobacco
                              - Alternative Dispute Resolution
                              - Animation
                              - Business Supplies and Equipment
                              - Design
                              - Environmental Services
                              - Events Services
                              - Executive Office
                              - Facilities Services
                              - Fund-Raising
                              - Graphic Design
                              - Human Resources
                              - Import and Export
                              - Individual & Family Services
                              - Information Services
                              - International Trade and Development
                              - Law Practice
                              - Legal Services
                              - Management Consulting
                              - Market Research
                              - Marketing and Advertising
                              - Outsourcing/Offshoring
                              - Professional Training & Coaching
                              - Program Development
                              - Public Relations and Communications
                              - Public Safety
                              - Security and Investigations
                              - Staffing and Recruiting
                              - Think Tanks
                              - Translation and Localization
                              - Writing and Editing
                              - Computer Games
                              - Computer Hardware
                              - Computer Networking
                              - Consumer Electronics
                              - Semiconductors
                              - Consumer Goods
                              - Consumer Services
                              - Education Management
                              - E-Learning
                              - Higher Education
                              - Primary/Secondary Education
                              - Research
                              - Oil & Energy
                              - Renewables & Environment
                              - Utilities
                              - Accounting
                              - Banking
                              - Capital Markets
                              - Financial Services
                              - Insurance
                              - Investment Banking
                              - Investment Management
                              - Venture Capital & Private Equity
                              - Defense & Space
                              - Government Administration
                              - Government Relations
                              - International Affairs
                              - Judiciary
                              - Law Enforcement
                              - Legislative Office
                              - Military
                              - Museums and Institutions
                              - Public Policy
                              - Alternative Medicine
                              - Biotechnology
                              - Health, Wellness and Fitness
                              - Hospital & Health Care
                              - Medical Devices
                              - Medical Practice
                              - Mental Health Care
                              - Pharmaceuticals
                              - Veterinary
                              - Automotive
                              - Aviation & Aerospace
                              - Chemicals
                              - Electrical/Electronic Manufacturing
                              - Furniture
                              - Industrial Automation
                              - Machinery
                              - Mechanical or Industrial Engineering
                              - Plastics
                              - Railroad Manufacture
                              - Shipbuilding
                              - Textiles
                              - Broadcast Media
                              - Media Production
                              - Motion Pictures and Film
                              - Music
                              - Newspapers
                              - Online Media
                              - Printing
                              - Publishing
                              - Civic & Social Organization
                              - Libraries
                              - Non-Profit Organization Management
                              - Philanthropy
                              - Political Organization
                              - Religious Institutions
                              - Arts and Crafts
                              - Nanotechnology
                              - Architecture & Planning
                              - Building Materials
                              - Civil Engineering
                              - Commercial Real Estate
                              - Construction
                              - Glass, Ceramics & Concrete
                              - Real Estate
                              - Apparel & Fashion
                              - Cosmetics
                              - Luxury Goods & Jewelry
                              - Retail
                              - Supermarkets
                              - Computer & Network Security
                              - Computer Software
                              - Information Technology and Services
                              - Internet
                              - Telecommunications
                              - Wireless
                              - Airlines/Aviation
                              - Logistics and Supply Chain
                              - Maritime
                              - Package/Freight Delivery
                              - Packaging and Containers
                              - Warehousing
                              - Transportation/Trucking/Railroad
                              - Entertainment
                              - Fine Art
                              - Gambling & Casinos
                              - Hospitality
                              - Leisure, Travel & Tourism
                              - Performing Arts
                              - Photography
                              - Recreational Facilities and Services
                              - Restaurants
                              - Sporting Goods
                              - Sports
                              - Wine and Spirits
                              - Wholesale
                            x-enumDescriptions:
                              Dairy: Dairy
                              Farming: Farming
                              Fishery: Fishery
                              Food & Beverages: Food & Beverages
                              Food Production: Food Production
                              Mining & Metals: Mining & Metals
                              Paper & Forest Products: Paper & Forest Products
                              Ranching: Ranching
                              Tobacco: Tobacco
                              Alternative Dispute Resolution: Alternative Dispute Resolution
                              Animation: Animation
                              Business Supplies and Equipment: Business Supplies and Equipment
                              Design: Design
                              Environmental Services: Environmental Services
                              Events Services: Events Services
                              Executive Office: Executive Office
                              Facilities Services: Facilities Services
                              Fund-Raising: Fund-Raising
                              Graphic Design: Graphic Design
                              Human Resources: Human Resources
                              Import and Export: Import and Export
                              Individual & Family Services: Individual & Family Services
                              Information Services: Information Services
                              International Trade and Development: International Trade and Development
                              Law Practice: Law Practice
                              Legal Services: Legal Services
                              Management Consulting: Management Consulting
                              Market Research: Market Research
                              Marketing and Advertising: Marketing and Advertising
                              Outsourcing/Offshoring: Outsourcing/Offshoring
                              Professional Training & Coaching: Professional Training & Coaching
                              Program Development: Program Development
                              Public Relations and Communications: Public Relations and Communications
                              Public Safety: Public Safety
                              Security and Investigations: Security and Investigations
                              Staffing and Recruiting: Staffing and Recruiting
                              Think Tanks: Think Tanks
                              Translation and Localization: Translation and Localization
                              Writing and Editing: Writing and Editing
                              Computer Games: Computer Games
                              Computer Hardware: Computer Hardware
                              Computer Networking: Computer Networking
                              Consumer Electronics: Consumer Electronics
                              Semiconductors: Semiconductors
                              Consumer Goods: Consumer Goods
                              Consumer Services: Consumer Services
                              Education Management: Education Management
                              E-Learning: E-Learning
                              Higher Education: Higher Education
                              Primary/Secondary Education: Primary/Secondary Education
                              Research: Research
                              Oil & Energy: Oil & Energy
                              Renewables & Environment: Renewables & Environment
                              Utilities: Utilities
                              Accounting: Accounting
                              Banking: Banking
                              Capital Markets: Capital Markets
                              Financial Services: Financial Services
                              Insurance: Insurance
                              Investment Banking: Investment Banking
                              Investment Management: Investment Management
                              Venture Capital & Private Equity: Venture Capital & Private Equity
                              Defense & Space: Defense & Space
                              Government Administration: Government Administration
                              Government Relations: Government Relations
                              International Affairs: International Affairs
                              Judiciary: Judiciary
                              Law Enforcement: Law Enforcement
                              Legislative Office: Legislative Office
                              Military: Military
                              Museums and Institutions: Museums and Institutions
                              Public Policy: Public Policy
                              Alternative Medicine: Alternative Medicine
                              Biotechnology: Biotechnology
                              Health, Wellness and Fitness: Health, Wellness and Fitness
                              Hospital & Health Care: Hospital & Health Care
                              Medical Devices: Medical Devices
                              Medical Practice: Medical Practice
                              Mental Health Care: Mental Health Care
                              Pharmaceuticals: Pharmaceuticals
                              Veterinary: Veterinary
                              Automotive: Automotive
                              Aviation & Aerospace: Aviation & Aerospace
                              Chemicals: Chemicals
                              Electrical/Electronic Manufacturing: Electrical/Electronic Manufacturing
                              Furniture: Furniture
                              Industrial Automation: Industrial Automation
                              Machinery: Machinery
                              Mechanical or Industrial Engineering: Mechanical or Industrial Engineering
                              Plastics: Plastics
                              Railroad Manufacture: Railroad Manufacture
                              Shipbuilding: Shipbuilding
                              Textiles: Textiles
                              Broadcast Media: Broadcast Media
                              Media Production: Media Production
                              Motion Pictures and Film: Motion Pictures and Film
                              Music: Music
                              Newspapers: Newspapers
                              Online Media: Online Media
                              Printing: Printing
                              Publishing: Publishing
                              Civic & Social Organization: Civic & Social Organization
                              Libraries: Libraries
                              Non-Profit Organization Management: Non-Profit Organization Management
                              Philanthropy: Philanthropy
                              Political Organization: Political Organization
                              Religious Institutions: Religious Institutions
                              Arts and Crafts: Arts and Crafts
                              Nanotechnology: Nanotechnology
                              Architecture & Planning: Architecture & Planning
                              Building Materials: Building Materials
                              Civil Engineering: Civil Engineering
                              Commercial Real Estate: Commercial Real Estate
                              Construction: Construction
                              Glass, Ceramics & Concrete: Glass, Ceramics & Concrete
                              Real Estate: Real Estate
                              Apparel & Fashion: Apparel & Fashion
                              Cosmetics: Cosmetics
                              Luxury Goods & Jewelry: Luxury Goods & Jewelry
                              Retail: Retail
                              Supermarkets: Supermarkets
                              Computer & Network Security: Computer & Network Security
                              Computer Software: Computer Software
                              Information Technology and Services: Information Technology and Services
                              Internet: Internet
                              Telecommunications: Telecommunications
                              Wireless: Wireless
                              Airlines/Aviation: Airlines/Aviation
                              Logistics and Supply Chain: Logistics and Supply Chain
                              Maritime: Maritime
                              Package/Freight Delivery: Package/Freight Delivery
                              Packaging and Containers: Packaging and Containers
                              Warehousing: Warehousing
                              Transportation/Trucking/Railroad: Transportation/Trucking/Railroad
                              Entertainment: Entertainment
                              Fine Art: Fine Art
                              Gambling & Casinos: Gambling & Casinos
                              Hospitality: Hospitality
                              Leisure, Travel & Tourism: Leisure, Travel & Tourism
                              Performing Arts: Performing Arts
                              Photography: Photography
                              Recreational Facilities and Services: Recreational Facilities and Services
                              Restaurants: Restaurants
                              Sporting Goods: Sporting Goods
                              Sports: Sports
                              Wine and Spirits: Wine and Spirits
                              Wholesale: Wholesale
                            example: Animation
                          description: >-
                            Subindustries of the lead company to exclude in the
                            search
                        include:
                          type: array
                          items:
                            type: string
                            enum:
                              - Dairy
                              - Farming
                              - Fishery
                              - Food & Beverages
                              - Food Production
                              - Mining & Metals
                              - Paper & Forest Products
                              - Ranching
                              - Tobacco
                              - Alternative Dispute Resolution
                              - Animation
                              - Business Supplies and Equipment
                              - Design
                              - Environmental Services
                              - Events Services
                              - Executive Office
                              - Facilities Services
                              - Fund-Raising
                              - Graphic Design
                              - Human Resources
                              - Import and Export
                              - Individual & Family Services
                              - Information Services
                              - International Trade and Development
                              - Law Practice
                              - Legal Services
                              - Management Consulting
                              - Market Research
                              - Marketing and Advertising
                              - Outsourcing/Offshoring
                              - Professional Training & Coaching
                              - Program Development
                              - Public Relations and Communications
                              - Public Safety
                              - Security and Investigations
                              - Staffing and Recruiting
                              - Think Tanks
                              - Translation and Localization
                              - Writing and Editing
                              - Computer Games
                              - Computer Hardware
                              - Computer Networking
                              - Consumer Electronics
                              - Semiconductors
                              - Consumer Goods
                              - Consumer Services
                              - Education Management
                              - E-Learning
                              - Higher Education
                              - Primary/Secondary Education
                              - Research
                              - Oil & Energy
                              - Renewables & Environment
                              - Utilities
                              - Accounting
                              - Banking
                              - Capital Markets
                              - Financial Services
                              - Insurance
                              - Investment Banking
                              - Investment Management
                              - Venture Capital & Private Equity
                              - Defense & Space
                              - Government Administration
                              - Government Relations
                              - International Affairs
                              - Judiciary
                              - Law Enforcement
                              - Legislative Office
                              - Military
                              - Museums and Institutions
                              - Public Policy
                              - Alternative Medicine
                              - Biotechnology
                              - Health, Wellness and Fitness
                              - Hospital & Health Care
                              - Medical Devices
                              - Medical Practice
                              - Mental Health Care
                              - Pharmaceuticals
                              - Veterinary
                              - Automotive
                              - Aviation & Aerospace
                              - Chemicals
                              - Electrical/Electronic Manufacturing
                              - Furniture
                              - Industrial Automation
                              - Machinery
                              - Mechanical or Industrial Engineering
                              - Plastics
                              - Railroad Manufacture
                              - Shipbuilding
                              - Textiles
                              - Broadcast Media
                              - Media Production
                              - Motion Pictures and Film
                              - Music
                              - Newspapers
                              - Online Media
                              - Printing
                              - Publishing
                              - Civic & Social Organization
                              - Libraries
                              - Non-Profit Organization Management
                              - Philanthropy
                              - Political Organization
                              - Religious Institutions
                              - Arts and Crafts
                              - Nanotechnology
                              - Architecture & Planning
                              - Building Materials
                              - Civil Engineering
                              - Commercial Real Estate
                              - Construction
                              - Glass, Ceramics & Concrete
                              - Real Estate
                              - Apparel & Fashion
                              - Cosmetics
                              - Luxury Goods & Jewelry
                              - Retail
                              - Supermarkets
                              - Computer & Network Security
                              - Computer Software
                              - Information Technology and Services
                              - Internet
                              - Telecommunications
                              - Wireless
                              - Airlines/Aviation
                              - Logistics and Supply Chain
                              - Maritime
                              - Package/Freight Delivery
                              - Packaging and Containers
                              - Warehousing
                              - Transportation/Trucking/Railroad
                              - Entertainment
                              - Fine Art
                              - Gambling & Casinos
                              - Hospitality
                              - Leisure, Travel & Tourism
                              - Performing Arts
                              - Photography
                              - Recreational Facilities and Services
                              - Restaurants
                              - Sporting Goods
                              - Sports
                              - Wine and Spirits
                              - Wholesale
                            x-enumDescriptions:
                              Dairy: Dairy
                              Farming: Farming
                              Fishery: Fishery
                              Food & Beverages: Food & Beverages
                              Food Production: Food Production
                              Mining & Metals: Mining & Metals
                              Paper & Forest Products: Paper & Forest Products
                              Ranching: Ranching
                              Tobacco: Tobacco
                              Alternative Dispute Resolution: Alternative Dispute Resolution
                              Animation: Animation
                              Business Supplies and Equipment: Business Supplies and Equipment
                              Design: Design
                              Environmental Services: Environmental Services
                              Events Services: Events Services
                              Executive Office: Executive Office
                              Facilities Services: Facilities Services
                              Fund-Raising: Fund-Raising
                              Graphic Design: Graphic Design
                              Human Resources: Human Resources
                              Import and Export: Import and Export
                              Individual & Family Services: Individual & Family Services
                              Information Services: Information Services
                              International Trade and Development: International Trade and Development
                              Law Practice: Law Practice
                              Legal Services: Legal Services
                              Management Consulting: Management Consulting
                              Market Research: Market Research
                              Marketing and Advertising: Marketing and Advertising
                              Outsourcing/Offshoring: Outsourcing/Offshoring
                              Professional Training & Coaching: Professional Training & Coaching
                              Program Development: Program Development
                              Public Relations and Communications: Public Relations and Communications
                              Public Safety: Public Safety
                              Security and Investigations: Security and Investigations
                              Staffing and Recruiting: Staffing and Recruiting
                              Think Tanks: Think Tanks
                              Translation and Localization: Translation and Localization
                              Writing and Editing: Writing and Editing
                              Computer Games: Computer Games
                              Computer Hardware: Computer Hardware
                              Computer Networking: Computer Networking
                              Consumer Electronics: Consumer Electronics
                              Semiconductors: Semiconductors
                              Consumer Goods: Consumer Goods
                              Consumer Services: Consumer Services
                              Education Management: Education Management
                              E-Learning: E-Learning
                              Higher Education: Higher Education
                              Primary/Secondary Education: Primary/Secondary Education
                              Research: Research
                              Oil & Energy: Oil & Energy
                              Renewables & Environment: Renewables & Environment
                              Utilities: Utilities
                              Accounting: Accounting
                              Banking: Banking
                              Capital Markets: Capital Markets
                              Financial Services: Financial Services
                              Insurance: Insurance
                              Investment Banking: Investment Banking
                              Investment Management: Investment Management
                              Venture Capital & Private Equity: Venture Capital & Private Equity
                              Defense & Space: Defense & Space
                              Government Administration: Government Administration
                              Government Relations: Government Relations
                              International Affairs: International Affairs
                              Judiciary: Judiciary
                              Law Enforcement: Law Enforcement
                              Legislative Office: Legislative Office
                              Military: Military
                              Museums and Institutions: Museums and Institutions
                              Public Policy: Public Policy
                              Alternative Medicine: Alternative Medicine
                              Biotechnology: Biotechnology
                              Health, Wellness and Fitness: Health, Wellness and Fitness
                              Hospital & Health Care: Hospital & Health Care
                              Medical Devices: Medical Devices
                              Medical Practice: Medical Practice
                              Mental Health Care: Mental Health Care
                              Pharmaceuticals: Pharmaceuticals
                              Veterinary: Veterinary
                              Automotive: Automotive
                              Aviation & Aerospace: Aviation & Aerospace
                              Chemicals: Chemicals
                              Electrical/Electronic Manufacturing: Electrical/Electronic Manufacturing
                              Furniture: Furniture
                              Industrial Automation: Industrial Automation
                              Machinery: Machinery
                              Mechanical or Industrial Engineering: Mechanical or Industrial Engineering
                              Plastics: Plastics
                              Railroad Manufacture: Railroad Manufacture
                              Shipbuilding: Shipbuilding
                              Textiles: Textiles
                              Broadcast Media: Broadcast Media
                              Media Production: Media Production
                              Motion Pictures and Film: Motion Pictures and Film
                              Music: Music
                              Newspapers: Newspapers
                              Online Media: Online Media
                              Printing: Printing
                              Publishing: Publishing
                              Civic & Social Organization: Civic & Social Organization
                              Libraries: Libraries
                              Non-Profit Organization Management: Non-Profit Organization Management
                              Philanthropy: Philanthropy
                              Political Organization: Political Organization
                              Religious Institutions: Religious Institutions
                              Arts and Crafts: Arts and Crafts
                              Nanotechnology: Nanotechnology
                              Architecture & Planning: Architecture & Planning
                              Building Materials: Building Materials
                              Civil Engineering: Civil Engineering
                              Commercial Real Estate: Commercial Real Estate
                              Construction: Construction
                              Glass, Ceramics & Concrete: Glass, Ceramics & Concrete
                              Real Estate: Real Estate
                              Apparel & Fashion: Apparel & Fashion
                              Cosmetics: Cosmetics
                              Luxury Goods & Jewelry: Luxury Goods & Jewelry
                              Retail: Retail
                              Supermarkets: Supermarkets
                              Computer & Network Security: Computer & Network Security
                              Computer Software: Computer Software
                              Information Technology and Services: Information Technology and Services
                              Internet: Internet
                              Telecommunications: Telecommunications
                              Wireless: Wireless
                              Airlines/Aviation: Airlines/Aviation
                              Logistics and Supply Chain: Logistics and Supply Chain
                              Maritime: Maritime
                              Package/Freight Delivery: Package/Freight Delivery
                              Packaging and Containers: Packaging and Containers
                              Warehousing: Warehousing
                              Transportation/Trucking/Railroad: Transportation/Trucking/Railroad
                              Entertainment: Entertainment
                              Fine Art: Fine Art
                              Gambling & Casinos: Gambling & Casinos
                              Hospitality: Hospitality
                              Leisure, Travel & Tourism: Leisure, Travel & Tourism
                              Performing Arts: Performing Arts
                              Photography: Photography
                              Recreational Facilities and Services: Recreational Facilities and Services
                              Restaurants: Restaurants
                              Sporting Goods: Sporting Goods
                              Sports: Sports
                              Wine and Spirits: Wine and Spirits
                              Wholesale: Wholesale
                            example: Animation
                          description: >-
                            Subindustries of the lead company to include in the
                            search
                    domains:
                      type: array
                      items:
                        type: string
                        description: Domains of the lead company to include in the search
                        example: google.com
                    funding_type:
                      type: array
                      items:
                        type: string
                        enum:
                          - angel
                          - seed
                          - pre_seed
                          - series_a
                          - pre_series_a
                          - series_b
                          - pre_series_b
                          - series_c
                          - pre_series_c
                          - series_d
                          - pre_series_d
                          - series_e
                          - pre_series_e
                          - series_f
                          - pre_series_f
                          - series_g
                          - pre_series_g
                          - series_h
                          - pre_series_h
                          - series_i
                          - pre_series_i
                          - series_j
                          - pre_series_j
                        x-enumDescriptions:
                          angel: Angel
                          seed: Seed
                          pre_seed: Pre-Seed
                          series_a: Series A
                          series_b: Series B
                          series_c: Series C
                          series_d: Series D
                          series_e: Series E
                          series_f: Series F
                          series_g: Series G
                          series_h: Series H
                          series_i: Series I
                          series_j: Series J
                          pre_series_a: Pre-Series A
                          pre_series_b: Pre-Series B
                          pre_series_c: Pre-Series C
                          pre_series_d: Pre-Series D
                          pre_series_e: Pre-Series E
                          pre_series_f: Pre-Series F
                          pre_series_g: Pre-Series G
                          pre_series_h: Pre-Series H
                          pre_series_i: Pre-Series I
                          pre_series_j: Pre-Series J
                        description: >-
                          Funding types of the lead company to include in the
                          search
                        example: angel
                    signals:
                      type: array
                      items:
                        oneOf:
                          - type: string
                            description: >-
                              Signal category name. Uses the default 30-day
                              freshness window.
                            example: job_change
                          - type: object
                            required:
                              - key
                            properties:
                              key:
                                type: string
                                description: Signal category to filter by.
                                example: job_change
                              period_days:
                                type: number
                                description: >-
                                  Freshness window in days. Only leads whose
                                  most recent signal of this category is within
                                  this window are returned. Defaults to 30 if
                                  omitted.
                                example: 7
                              keywords:
                                oneOf:
                                  - type: array
                                    items:
                                      type: string
                                      example: artificial intelligence
                                    description: >-
                                      Legacy flat list of keyword tokens
                                      (OR-matched across every keyword index
                                      field for the category).
                                  - type: object
                                    description: >-
                                      Per-field map of keyword tokens. Each
                                      property name is a keyword index field;
                                      each value is the list of tokens to
                                      OR-match within that field. Records must
                                      have at least one matching token in EACH
                                      selected field — fields act as additional
                                      filters. Example: `{ "objection_type":
                                      ["security"], "buying_stage":
                                      ["consideration"] }`.
                                    additionalProperties:
                                      type: array
                                      items:
                                        type: string
                                        example: security
                            additionalProperties: false
                      description: >-
                        Filter leads by Autobound signal categories (e.g. job
                        changes, traffic surges, LinkedIn activity). Leads
                        matching ANY of the specified signals within the
                        per-signal freshness window will be returned.
                    skip_owned_leads:
                      type: boolean
                      description: >-
                        If set, the lead finder will skip leads that are owned
                        by the user
                      example: true
                    show_one_lead_per_company:
                      type: boolean
                      description: >-
                        If set, the lead finder will show only one lead per
                        company
                      example: true
                    location_mode:
                      type: string
                      enum:
                        - contact
                        - company
                      description: >-
                        Whether to filter/display by contact location or company
                        HQ location. Defaults to contact.
                      example: contact
                skip_owned_leads:
                  type: boolean
                  description: Skip leads that belong to the current workspace
                  example: true
                show_one_lead_per_company:
                  type: boolean
                  description: Return only one lead per company
                  example: true
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  number_of_leads:
                    type: number
                    description: >-
                      Number of leads found for this specific search. A value of
                      0 indicates that no leads match the criteria. Values
                      greater than 1,000,000 are returned as 1,000,000.
                    example: 100
                  number_of_redacted_results:
                    type: number
                    description: >-
                      Number of results that were redacted/hidden (for trial
                      users).
                    example: 0
                  leads:
                    type: array
                    description: The leads matching the search criteria
                    items:
                      type: object
                      properties:
                        firstName:
                          type: string
                          description: The first name of the lead
                          example: John
                        lastName:
                          type: string
                          description: The last name of the lead
                          example: Doe
                        fullName:
                          type: string
                          description: The full name of the lead
                          example: John Doe
                        jobTitle:
                          type: string
                          description: The current job title of the lead
                          example: Software Engineer
                        location:
                          type: string
                          description: >-
                            The location of the lead (contact location or
                            company HQ depending on location_mode filter)
                          example: San Francisco, California, United States
                        linkedIn:
                          type: string
                          description: LinkedIn profile URL of the lead
                          example: linkedin.com/in/john-doe
                        companyName:
                          type: string
                          description: The name of the lead’s company
                          example: Acme Corp
                        companyLogo:
                          type: string
                          description: URL of the company logo
                          example: https://example.com/logo.png
                        companyId:
                          type: string
                          description: >-
                            The LinkedIn company ID, used for viewing company
                            details
                          example: '123456'
                      additionalProperties: false
        '401':
          description: >-
            This request is unauthorized (either the Authorization header is
            missing or invalid, or the API key has been revoked)
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 401
                    example: 401
                  error:
                    type: string
                    enum:
                      - Unauthorized
                    example: Unauthorized
                  message:
                    type: string
                    example: Missing Authorization header
                required:
                  - statusCode
                  - error
                  - message
        '402':
          description: >-
            This request cannot be fulfilled because the workspace does not have
            an active paid plan
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 402
                    example: 402
                  error:
                    type: string
                    enum:
                      - Payment Required
                    example: Payment Required
                  message:
                    type: string
                    example: Workspace does not have an active paid plan
                required:
                  - statusCode
                  - error
                  - message
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 404
                    example: 404
                  error:
                    type: string
                    enum:
                      - Not Found
                    example: Not Found
                  message:
                    type: string
                    example: Resource not found
                required:
                  - statusCode
                  - error
                  - message
        '429':
          description: >-
            You have exceeded the rate limit. Please check the rate limit docs
            for more information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 429
                    example: 429
                  error:
                    type: string
                    enum:
                      - Too Many Requests
                    example: Too Many Requests
                  message:
                    type: string
                    example: Rate limit exceeded
                required:
                  - statusCode
                  - error
                  - message
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer

````