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

# Export a company search asynchronously

> Pages through a company search in the background, up to `limit` results, and stores the records for download. The query is the same as `POST /v2/companies/search`, without `pageSize` and `cursor`. Requires an API key. Each page is an ordinary search request at the normal per-record price, with the requested expansions; the last page asks only for the results still missing, and results whose record is unavailable are skipped. There is no upfront balance check: a failed page, such as a `402` once credits run out, stops the export, and the records already exported stay downloadable. `limit` cannot exceed your plan's search limit. `GET /v2/batches/{id}` reports progress with `recordCount` and `recordLimit`, and `resultsUrl` downloads the records.



## OpenAPI

````yaml openapi/v2.json POST /v2/companies/search/export
openapi: 3.0.4
info:
  title: Company Enrich API v2
  description: >-
    The Company Enrich API v2 provides programmatic access to company and person
    data for enrichment, search, and lead generation.


    ## Key Features


    - **Company Enrichment** — Enrich company profiles by domain or identifying
    properties, and retrieve stored companies by ID.

    - **Company Search** — Search and filter companies with cursor pagination,
    counts, and previews.

    - **Semantic and Lookalike Search** — Find companies using natural-language
    queries or similar company domains.

    - **People Enrichment** — Retrieve people by ID, identify people from their
    email address, and find work email addresses.

    - **People Search** — Search people by position, seniority, department,
    location, education, and company with cursor pagination, counts, and
    previews.

    - **Reference Data** — Look up industries, geographic data, keywords,
    technologies, and job titles.


    V2 intentionally excludes saved company lists, list-based exports, and
    filtering searches by saved-list IDs. These features remain available in V1
    and are not planned for V2.


    ## Authentication


    All API requests require a Bearer token passed in the `Authorization`
    header:


    ```

    Authorization: Bearer YOUR_API_TOKEN

    ```


    You can generate API tokens from your
    [dashboard](https://companyenrich.com/dashboard).


    ## Credits


    Most API calls consume credits. The credit cost for each endpoint is
    documented in its description. You can check your remaining credit balance
    using the User endpoint.


    ## Rate Limiting


    The global API limiter allows **500 requests per minute** per IP address.
    Authenticated API routes also use a per-user route limiter based on plan
    capabilities.

    Supplementary lookup endpoints (such as keyword/technology/industry
    autocompletes) use a separate per-user route-level bucket.
  termsOfService: https://companyenrich.com/terms-and-conditions
  contact:
    url: https://companyenrich.com/
    email: support@companyenrich.com
  version: 2.0.0
servers:
  - url: https://api.companyenrich.com
security:
  - Bearer: []
tags:
  - name: Company / Enrichment
    description: >-
      Enrich company data by domain, properties, or in batch. Get company
      details by ID.
  - name: Company / Bulk Enrichment
    description: >-
      Create and manage asynchronous bulk enrichment jobs for large domain
      lists.
  - name: Company / Search
    description: Search companies by filters with pagination and cursor scrolling.
  - name: People / Search
    description: >-
      Search people by various criteria with page-based or cursor-based
      pagination.
  - name: People / Enrichment
    description: >-
      Resolve work email addresses for individual people in realtime or
      background jobs.
  - name: Geo
    description: >-
      Endpoints for looking up geographic data including regions, countries,
      states, and cities.
  - name: Industries
    description: >-
      Endpoints for listing available industry classifications used in company
      search filters.
  - name: Keywords
    description: Endpoints for looking up keywords used in company search filters.
  - name: Technologies
    description: Endpoints for looking up technologies used in company search filters.
  - name: User
    description: >-
      Endpoints for retrieving information about the authenticated user,
      including credit balance and account details.
  - name: Positions
    description: Endpoints for looking up job positions and titles.
paths:
  /v2/companies/search/export:
    post:
      tags:
        - Company / Search Export
      summary: Export a company search asynchronously
      description: >-
        Pages through a company search in the background, up to `limit` results,
        and stores the records for download. The query is the same as `POST
        /v2/companies/search`, without `pageSize` and `cursor`. Requires an API
        key. Each page is an ordinary search request at the normal per-record
        price, with the requested expansions; the last page asks only for the
        results still missing, and results whose record is unavailable are
        skipped. There is no upfront balance check: a failed page, such as a
        `402` once credits run out, stops the export, and the records already
        exported stay downloadable. `limit` cannot exceed your plan's search
        limit. `GET /v2/batches/{id}` reports progress with `recordCount` and
        `recordLimit`, and `resultsUrl` downloads the records.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanySearchExportRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchStatusResponse'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '402':
          description: Payment Required
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '422':
          description: Unprocessable Entity
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpValidationProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: Service Unavailable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    CompanySearchExportRequest:
      required:
        - limit
      type: object
      properties:
        limit:
          maximum: 1000000
          minimum: 1
          type: integer
          description: >-
            The maximum number of search results to export. Results whose
            company is no longer available are skipped, so an export can return
            fewer companies. Your plan's search limit also applies.
          format: int32
          nullable: true
        expand:
          type: array
          items:
            enum:
              - financial
              - keywords
              - naicsCodes
              - technologies
              - workforce
            type: string
          description: >-
            Additional company data to include. Each requested expansion is
            charged per returned company, on top of the base cost:


            - `financial`: 1 credit

            - `keywords`: 1 credit

            - `naicsCodes`: 1 credit

            - `technologies`: 1 credit

            - `workforce`: 1 credit. Includes the latest 12 months of history;
            each earlier 12-month page from `GET /v2/companies/workforce` costs
            another 1 credit.
          nullable: true
        filter:
          $ref: '#/components/schemas/CompanySearchFilter'
        semantic:
          $ref: '#/components/schemas/CompanySemanticQuery'
        lookalike:
          $ref: '#/components/schemas/CompanyLookalikeQuery'
    BatchStatusResponse:
      required:
        - id
        - kind
        - status
        - progress
        - creditsCharged
        - createdAt
        - statusUrl
        - resultsUrl
        - rawResultsUrl
      type: object
      properties:
        id:
          type: string
          description: The batch ID.
          format: uuid
        kind:
          type: string
          description: The task represented by the batch.
        status:
          $ref: '#/components/schemas/HttpBatchState'
        progress:
          $ref: '#/components/schemas/BatchProgressResponse'
        creditsCharged:
          type: number
          description: The credits charged so far, in user-visible credits.
          format: double
        recordCount:
          type: integer
          description: >-
            For a search export, the number of records its settled pages
            returned.
          format: int32
          nullable: true
        recordLimit:
          type: integer
          description: >-
            For a search export, the most search results it requests. Results
            whose record is unavailable are skipped, so `recordCount` can end
            below it.
          format: int32
          nullable: true
        createdAt:
          type: string
          description: When the batch was created.
          format: date-time
        completedAt:
          type: string
          description: When the batch completed or was cancelled, if terminal.
          format: date-time
          nullable: true
        statusUrl:
          type: string
          description: The authenticated URL for checking batch status and progress.
        resultsUrl:
          type: string
          description: >-
            The download URL for the task's projected results. It is signed, so
            it works without credentials for one hour; after that, use the
            owner's credentials or a URL from a new status response.
        rawResultsUrl:
          type: string
          description: >-
            The download URL for raw HTTP outcomes in NDJSON format, signed like
            `resultsUrl`.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
    HttpValidationProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    CompanySearchFilter:
      type: object
      properties:
        query:
          oneOf:
            - title: Single value
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            Queries matching company names, keywords, or domain prefixes. A
            string or array matches any query. Inclusions use OR; exclusions
            remove matches. Each entry supports the existing text query syntax,
            up to 250 characters. A blank string is treated as no query; blank
            entries in arrays or matching rules are invalid.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        id:
          oneOf:
            - title: Single value
              type: string
              description: Include results that match this value.
              format: uuid
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
                format: uuid
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The company ids to match. A single value or array matches any
            provided id.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        domain:
          oneOf:
            - title: Single value
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The company domains to match. A single value or array matches any
            provided domain.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        keywords:
          oneOf:
            - title: Single value
              type: string
              description: Only match when this value matches the target.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
              description: Only match when every provided value matches the target.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
                all:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when every provided value is present in the
                    target collection
              additionalProperties: false
              description: >-
                Configure values that may match, must all match, or must be
                excluded.
          description: >-
            The keywords to match. A single value or array requires every
            provided keyword.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        technologies:
          oneOf:
            - title: Single value
              type: string
              description: Only match when this value matches the target.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
              description: Only match when every provided value matches the target.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
                all:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when every provided value is present in the
                    target collection
              additionalProperties: false
              description: >-
                Configure values that may match, must all match, or must be
                excluded.
          description: >-
            The technologies to match. A single value or array requires every
            provided technology.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        region:
          oneOf:
            - title: Single value
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The regions to match. A single value or array matches any provided
            region.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        country:
          oneOf:
            - title: Single value
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The countries to match. A single value or array matches any provided
            country.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        state:
          oneOf:
            - title: Single value
              type: integer
              description: Include results that match this value.
              format: int32
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: integer
                format: int32
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: integer
                    format: int32
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: integer
                    format: int32
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The state ids to match. A single value or array matches any provided
            id.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        city:
          oneOf:
            - title: Single value
              type: integer
              description: Include results that match this value.
              format: int32
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: integer
                format: int32
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: integer
                    format: int32
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: integer
                    format: int32
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The city ids to match. A single value or array matches any provided
            id.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        type:
          oneOf:
            - title: Single value
              enum:
                - private
                - public
                - self-employed
                - self-owned
                - partnership
                - nonprofit
                - educational
                - government
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                enum:
                  - private
                  - public
                  - self-employed
                  - self-owned
                  - partnership
                  - nonprofit
                  - educational
                  - government
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - private
                      - public
                      - self-employed
                      - self-owned
                      - partnership
                      - nonprofit
                      - educational
                      - government
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - private
                      - public
                      - self-employed
                      - self-owned
                      - partnership
                      - nonprofit
                      - educational
                      - government
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The company types to match. A single value or array matches any
            provided type.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        employees:
          oneOf:
            - title: Single value
              enum:
                - 1-10
                - 11-50
                - 51-200
                - 201-500
                - 501-1K
                - 1K-5K
                - 5K-10K
                - over-10K
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                enum:
                  - 1-10
                  - 11-50
                  - 51-200
                  - 201-500
                  - 501-1K
                  - 1K-5K
                  - 5K-10K
                  - over-10K
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - 1-10
                      - 11-50
                      - 51-200
                      - 201-500
                      - 501-1K
                      - 1K-5K
                      - 5K-10K
                      - over-10K
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - 1-10
                      - 11-50
                      - 51-200
                      - 201-500
                      - 501-1K
                      - 1K-5K
                      - 5K-10K
                      - over-10K
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The employee ranges to match. A single value or array matches any
            provided range.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        reportedEmployees:
          oneOf:
            - title: Single value
              enum:
                - 1-10
                - 11-50
                - 51-200
                - 201-500
                - 501-1K
                - 1K-5K
                - 5K-10K
                - over-10K
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                enum:
                  - 1-10
                  - 11-50
                  - 51-200
                  - 201-500
                  - 501-1K
                  - 1K-5K
                  - 5K-10K
                  - over-10K
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - 1-10
                      - 11-50
                      - 51-200
                      - 201-500
                      - 501-1K
                      - 1K-5K
                      - 5K-10K
                      - over-10K
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - 1-10
                      - 11-50
                      - 51-200
                      - 201-500
                      - 501-1K
                      - 1K-5K
                      - 5K-10K
                      - over-10K
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The externally reported employee ranges to match. A single value or
            array matches any provided range.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        revenue:
          oneOf:
            - title: Single value
              enum:
                - under-1m
                - 1m-10m
                - 10m-50m
                - 50m-100m
                - 100m-200m
                - 200m-1b
                - over-1b
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                enum:
                  - under-1m
                  - 1m-10m
                  - 10m-50m
                  - 50m-100m
                  - 100m-200m
                  - 200m-1b
                  - over-1b
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - under-1m
                      - 1m-10m
                      - 10m-50m
                      - 50m-100m
                      - 100m-200m
                      - 200m-1b
                      - over-1b
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - under-1m
                      - 1m-10m
                      - 10m-50m
                      - 50m-100m
                      - 100m-200m
                      - 200m-1b
                      - over-1b
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The revenue ranges to match. A single value or array matches any
            provided range.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        workforceGrowth:
          $ref: '#/components/schemas/CompanyWorkforceGrowthV2Filter'
        workforceSize:
          type: array
          items:
            $ref: '#/components/schemas/CompanyWorkforceSizeV2Filter'
          description: The workforce headcount ranges of companies, by department
          nullable: true
        naicsCodes:
          oneOf:
            - title: Single value
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
                all:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: >-
                    Only match when every provided value is present in the
                    target collection
              additionalProperties: false
              description: >-
                Configure values that may match, must all match, or must be
                excluded.
          description: >-
            The NAICS code strings to match, each containing 2 to 6 ASCII digits
            without a leading zero. Surrounding whitespace is ignored. A single
            value or array matches any provided code.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        categories:
          oneOf:
            - title: Single value
              enum:
                - b2b
                - b2c
                - b2g
                - e-commerce
                - media
                - service-provider
                - mobile
                - saas
                - local-business
              type: string
              description: Only match when this value matches the target.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                enum:
                  - b2b
                  - b2c
                  - b2g
                  - e-commerce
                  - media
                  - service-provider
                  - mobile
                  - saas
                  - local-business
                type: string
              description: Only match when every provided value matches the target.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - b2b
                      - b2c
                      - b2g
                      - e-commerce
                      - media
                      - service-provider
                      - mobile
                      - saas
                      - local-business
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - b2b
                      - b2c
                      - b2g
                      - e-commerce
                      - media
                      - service-provider
                      - mobile
                      - saas
                      - local-business
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
                all:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - b2b
                      - b2c
                      - b2g
                      - e-commerce
                      - media
                      - service-provider
                      - mobile
                      - saas
                      - local-business
                    type: string
                  description: >-
                    Only match when every provided value is present in the
                    target collection
              additionalProperties: false
              description: >-
                Configure values that may match, must all match, or must be
                excluded.
          description: >-
            The categories to match. A single value or array requires every
            provided category.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        foundedYear:
          $ref: '#/components/schemas/YearRangeFilter'
        fundingRounds:
          oneOf:
            - title: Single value
              enum:
                - seed
                - debt_financing
                - angel
                - venture
                - series_a
                - series_b
                - series_c
                - series_d
                - series_e
                - series_f
                - series_g
                - series_h
                - other
              type: string
              description: Include results that match this value.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                enum:
                  - seed
                  - debt_financing
                  - angel
                  - venture
                  - series_a
                  - series_b
                  - series_c
                  - series_d
                  - series_e
                  - series_f
                  - series_g
                  - series_h
                  - other
                type: string
              description: Include results that match at least one of these values.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                in:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - seed
                      - debt_financing
                      - angel
                      - venture
                      - series_a
                      - series_b
                      - series_c
                      - series_d
                      - series_e
                      - series_f
                      - series_g
                      - series_h
                      - other
                    type: string
                  description: >-
                    Only match when the target value is one of the provided
                    values
                notIn:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - seed
                      - debt_financing
                      - angel
                      - venture
                      - series_a
                      - series_b
                      - series_c
                      - series_d
                      - series_e
                      - series_f
                      - series_g
                      - series_h
                      - other
                    type: string
                  description: >-
                    Exclude results when the target value is one of the provided
                    values
              additionalProperties: false
              description: Configure values that may match or must be excluded.
          description: >-
            The funding rounds to match. A single value or array matches any
            provided round.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
        fundingAmount:
          $ref: '#/components/schemas/AmountRangeFilter'
        fundingYear:
          $ref: '#/components/schemas/YearRangeFilter2'
        require:
          oneOf:
            - title: Single value
              enum:
                - linkedin
                - twitter
                - facebook
                - instagram
                - angellist
                - crunchbase
                - youtube
                - country
                - city
                - state
                - revenue
                - foundedYear
                - anyFunding
              type: string
              description: Only match when this value matches the target.
            - title: Multiple values
              minItems: 1
              type: array
              items:
                enum:
                  - linkedin
                  - twitter
                  - facebook
                  - instagram
                  - angellist
                  - crunchbase
                  - youtube
                  - country
                  - city
                  - state
                  - revenue
                  - foundedYear
                  - anyFunding
                type: string
              description: Only match when every provided value matches the target.
            - title: Advanced matching rules
              minProperties: 1
              type: object
              properties:
                all:
                  minItems: 1
                  type: array
                  items:
                    enum:
                      - linkedin
                      - twitter
                      - facebook
                      - instagram
                      - angellist
                      - crunchbase
                      - youtube
                      - country
                      - city
                      - state
                      - revenue
                      - foundedYear
                      - anyFunding
                    type: string
                  description: Only match when every provided value matches the target
              additionalProperties: false
              description: Configure values that must all match.
          description: >-
            The features companies must have. A single value or array requires
            every provided feature.


            Provide a single value, multiple values, or advanced matching rules.
          nullable: true
      description: The filters to apply to the company search
      nullable: true
    CompanySemanticQuery:
      required:
        - query
      type: object
      properties:
        query:
          maxLength: 500
          type: string
          description: The natural-language query used to find companies
        weight:
          maximum: 1
          minimum: 0
          type: number
          description: >-
            The semantic relevance weight. Larger values prioritize semantic
            similarity.
          format: double
          nullable: true
        autoFilter:
          type: boolean
          description: >-
            Whether to infer company attributes such as location, size, and
            business model from the query. Defaults to true. Inferred location,
            employee, founded year, and funding values filter results; inferred
            company names, categories, and revenue rank matching companies
            higher. Attributes the request includes values for are not inferred;
            request exclusions apply together with inferred values. The response
            `interpretation` reports inferred values.
          nullable: true
      description: The semantic query used to find relevant companies
      nullable: true
    CompanyLookalikeQuery:
      required:
        - domains
      type: object
      properties:
        domains:
          maxItems: 10
          minItems: 1
          type: array
          items:
            type: string
          description: The seed company domains used to find lookalike companies
        weight:
          maximum: 1
          minimum: -1
          type: number
          description: >-
            The ranking weight for company similarity. Larger values prioritize
            more similar companies.
          format: double
          nullable: true
        minScore:
          maximum: 1
          minimum: 0
          type: number
          description: >-
            The minimum vector similarity required before lookalike ranking
            penalties are applied
          format: double
          nullable: true
      description: The seed companies used to find lookalike companies
      nullable: true
    HttpBatchState:
      enum:
        - pending
        - running
        - completed
        - cancelling
        - cancelled
      description: The current batch state.
    BatchProgressResponse:
      required:
        - total
        - pending
        - running
        - succeeded
        - failed
        - unknown
        - cancelled
      type: object
      properties:
        total:
          type: integer
          description: >-
            The number of requests. A search export adds one for each page as
            the previous page settles.
          format: int32
        pending:
          type: integer
          description: Requests awaiting dispatch, including retries.
          format: int32
        running:
          type: integer
          description: >-
            Requests still being processed, including saved results not yet
            settled.
          format: int32
        succeeded:
          type: integer
          description: Requests that returned a successful HTTP response.
          format: int32
        failed:
          type: integer
          description: Requests that returned an HTTP error response.
          format: int32
        unknown:
          type: integer
          description: Requests whose execution outcome could not be confirmed.
          format: int32
        cancelled:
          type: integer
          description: Requests cancelled before their results were published.
          format: int32
      description: The number of requests in each state.
    CompanyWorkforceGrowthV2Filter:
      type: object
      properties:
        period:
          $ref: '#/components/schemas/NullableOfCompanyWorkforceGrowthPeriod'
        department:
          $ref: '#/components/schemas/NullableOfCompanyWorkforceGrowthDepartment'
        min:
          type: number
          description: The minimum growth ratio (inclusive). 0.15 represents 15% growth.
          format: float
          nullable: true
        max:
          type: number
          description: The maximum growth ratio (inclusive). 0.15 represents 15% growth.
          format: float
          nullable: true
      description: The workforce growth ratio range of companies
      nullable: true
    CompanyWorkforceSizeV2Filter:
      type: object
      properties:
        department:
          $ref: '#/components/schemas/NullableOfCompanyWorkforceGrowthDepartment2'
        min:
          type: integer
          description: The minimum headcount (inclusive).
          format: int32
          nullable: true
        max:
          type: integer
          description: The maximum headcount (inclusive).
          format: int32
          nullable: true
    YearRangeFilter:
      type: object
      properties:
        min:
          type: integer
          description: The minimum value (inclusive)
          format: int32
          nullable: true
        max:
          type: integer
          description: The maximum value (inclusive)
          format: int32
          nullable: true
      description: The founded year range of companies
      nullable: true
    AmountRangeFilter:
      type: object
      properties:
        min:
          type: number
          description: The minimum value (inclusive)
          format: double
          nullable: true
        max:
          type: number
          description: The maximum value (inclusive)
          format: double
          nullable: true
      description: The funding amount range of companies
      nullable: true
    YearRangeFilter2:
      type: object
      properties:
        min:
          type: integer
          description: The minimum value (inclusive)
          format: int32
          nullable: true
        max:
          type: integer
          description: The maximum value (inclusive)
          format: int32
          nullable: true
      description: The latest funding year range of companies
      nullable: true
    NullableOfCompanyWorkforceGrowthPeriod:
      enum:
        - m6
        - y1
        - y2
        - null
      description: The period to measure workforce growth over.
      nullable: true
    NullableOfCompanyWorkforceGrowthDepartment:
      enum:
        - overall
        - c_suite
        - product_management
        - engineering_technical
        - design
        - education
        - finance
        - human_resources
        - information_technology
        - legal
        - marketing
        - medical_health
        - operations
        - sales
        - consulting
        - null
      description: The department to measure workforce growth for.
      nullable: true
    NullableOfCompanyWorkforceGrowthDepartment2:
      enum:
        - overall
        - c_suite
        - product_management
        - engineering_technical
        - design
        - education
        - finance
        - human_resources
        - information_technology
        - legal
        - marketing
        - medical_health
        - operations
        - sales
        - consulting
        - null
      description: >-
        The department to filter headcount for. Defaults to overall if not
        specified.
      nullable: true
  securitySchemes:
    Bearer:
      type: apiKey
      description: >-
        API Token used for authentication. Example: "Authorization: Bearer
        {token}"
      name: Authorization
      in: header
      x-bearer-format: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.