> ## 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.

# Search companies

> Search companies using filters, a natural-language query, or lookalike seed domains.

Standard search costs 1 credit per returned company, semantic search costs 2, and lookalike search costs 5, plus requested paid expansions. Empty results cost one result's base price.

Each requested expansion (`financial`, `keywords`, `naicsCodes`, `technologies`, or `workforce`) adds 1 credit per returned company. `workforce` includes the latest 12 months of history. Use its `nextCursor` with `GET /v2/companies/workforce` to retrieve each preceding 12-month page for another 1 credit. Repeating an expansion does not multiply its cost.

The request can contain standard filters, a semantic query, or lookalike seed companies. Filters can be combined with either search mode, but semantic and lookalike searches cannot be combined.

Semantic queries infer company attributes by default. For example, `saas companies in Turkey` filters companies in Turkey and ranks companies categorized as SaaS higher. Inferred location, employee, founded year, and funding values filter results. Inferred company names, categories, and revenue rank matching companies higher without excluding others; a company the query names, such as `Monzo` in `Monzo digital bank`, ranks first. Request filters that include values take precedence over inferred values of the same kind; request exclusions apply together with inferred values. The response `interpretation` reports what was inferred. Set `semantic.autoFilter` to `false` to disable inference.

Send an empty object (`{}`) to search without filters.

Results use cursor pagination. Omit `cursor` for the first page and pass a cursor returned by the previous response to continue. Numbered pagination is not supported.

Keep the same query when continuing a search. Cursors expire 24 hours after the first page. Lookalike searches reorder the first 150 matches; subsequent matches retain their original order. Preserve the returned order rather than sorting all results by score.

A value filter supports these input forms:

- match one value: `"TR"`
- match several values using the field's default rule: `["TR", "US"]`
- configure advanced matching rules: `{ "in": ["TR"], "notIn": ["US"] }`

A single value or array matches any provided value for scalar fields, NAICS codes, and funding rounds. For keywords, technologies, categories, and required features, every provided value must match. The object form can select another supported matching rule explicitly.



## OpenAPI

````yaml openapi/v2.json POST /v2/companies/search
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:
    post:
      tags:
        - Company / Search
      summary: Search companies
      description: >-
        Search companies using filters, a natural-language query, or lookalike
        seed domains.


        Standard search costs 1 credit per returned company, semantic search
        costs 2, and lookalike search costs 5, plus requested paid expansions.
        Empty results cost one result's base price.


        Each requested expansion (`financial`, `keywords`, `naicsCodes`,
        `technologies`, or `workforce`) adds 1 credit per returned company.
        `workforce` includes the latest 12 months of history. Use its
        `nextCursor` with `GET /v2/companies/workforce` to retrieve each
        preceding 12-month page for another 1 credit. Repeating an expansion
        does not multiply its cost.


        The request can contain standard filters, a semantic query, or lookalike
        seed companies. Filters can be combined with either search mode, but
        semantic and lookalike searches cannot be combined.


        Semantic queries infer company attributes by default. For example, `saas
        companies in Turkey` filters companies in Turkey and ranks companies
        categorized as SaaS higher. Inferred location, employee, founded year,
        and funding values filter results. Inferred company names, categories,
        and revenue rank matching companies higher without excluding others; a
        company the query names, such as `Monzo` in `Monzo digital bank`, ranks
        first. Request filters that include values take precedence over inferred
        values of the same kind; request exclusions apply together with inferred
        values. The response `interpretation` reports what was inferred. Set
        `semantic.autoFilter` to `false` to disable inference.


        Send an empty object (`{}`) to search without filters.


        Results use cursor pagination. Omit `cursor` for the first page and pass
        a cursor returned by the previous response to continue. Numbered
        pagination is not supported.


        Keep the same query when continuing a search. Cursors expire 24 hours
        after the first page. Lookalike searches reorder the first 150 matches;
        subsequent matches retain their original order. Preserve the returned
        order rather than sorting all results by score.


        A value filter supports these input forms:


        - match one value: `"TR"`

        - match several values using the field's default rule: `["TR", "US"]`

        - configure advanced matching rules: `{ "in": ["TR"], "notIn": ["US"] }`


        A single value or array matches any provided value for scalar fields,
        NAICS codes, and funding rounds. For keywords, technologies, categories,
        and required features, every provided value must match. The object form
        can select another supported matching rule explicitly.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanySearchV2Request'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanySearchV2Response'
        '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'
        '404':
          description: Not Found
          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'
components:
  schemas:
    CompanySearchV2Request:
      type: object
      properties:
        pageSize:
          maximum: 100
          minimum: 1
          type: integer
          description: The maximum number of companies to return
          format: int32
        cursor:
          maxLength: 1024
          type: string
          description: >-
            An opaque cursor returned by a previous search response. Omit for
            the first page.
          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'
    CompanySearchV2Response:
      required:
        - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CompanyResponse'
          description: The companies returned for this page
        nextCursor:
          type: string
          description: >-
            An opaque cursor for the next page. Omitted when there are no more
            results.
          nullable: true
        scores:
          type: object
          additionalProperties:
            type: number
            format: double
          description: >-
            Ranking scores by company ID for lookalike searches. The first 150
            matches include ranking penalties; later matches retain their
            original scores and order. Scores are not probabilities. Preserve
            the returned item order.
          nullable: true
        interpretation:
          $ref: '#/components/schemas/CompanySemanticInterpretationResponse'
    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
    CompanyResponse:
      required:
        - id
        - domain
        - website
        - logoUrl
        - updatedAt
      type: object
      properties:
        id:
          type: string
          description: The CompanyEnrich ID of the company
          format: uuid
        name:
          type: string
          description: The company name
          nullable: true
        legalName:
          type: string
          description: The legal name of the company
          nullable: true
        domain:
          type: string
          description: The primary domain of the company
        website:
          type: string
          description: The company website URL
        logoUrl:
          type: string
          description: The company logo URL
        description:
          type: string
          description: The company description
          nullable: true
        type:
          $ref: '#/components/schemas/NullableOfCompanyType'
        foundedYear:
          type: integer
          description: The year the company was founded
          format: int32
          nullable: true
        employees:
          $ref: '#/components/schemas/NullableOfCompanyEmployees'
        revenue:
          $ref: '#/components/schemas/NullableOfCompanyRevenue'
        industry:
          type: string
          description: The primary industry of the company
          nullable: true
        industries:
          type: array
          items:
            type: string
          description: The industries associated with the company
          nullable: true
        categories:
          type: array
          items:
            $ref: '#/components/schemas/CompanyCategory'
          description: >-
            The categories associated with the company, from most to least
            specific
          nullable: true
        location:
          $ref: '#/components/schemas/CompanyLocationResponse'
        socials:
          $ref: '#/components/schemas/CompanySocialsResponse'
        updatedAt:
          type: string
          description: When the company data was last updated
          format: date-time
        financial:
          $ref: '#/components/schemas/CompanyFinancialResponse'
        keywords:
          type: array
          items:
            type: string
          description: >-
            Keywords associated with the company. Included when `keywords` is
            requested in `expand`.
          nullable: true
        naicsCodes:
          type: array
          items:
            type: string
          description: >-
            The NAICS codes associated with the company. Included when
            `naicsCodes` is requested in `expand`.
          nullable: true
        technologies:
          type: array
          items:
            type: string
          description: >-
            Technologies used by the company. Included when `technologies` is
            requested in `expand`.
          nullable: true
        workforce:
          $ref: '#/components/schemas/CompanyWorkforceResponse'
    CompanySemanticInterpretationResponse:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/CompanySearchFilter2'
        boost:
          $ref: '#/components/schemas/CompanySemanticBoostResponse'
      description: >-
        How the semantic query was interpreted. Present for semantic queries
        with `autoFilter` enabled.
      nullable: true
    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
    NullableOfCompanyType:
      enum:
        - private
        - public
        - self-employed
        - self-owned
        - partnership
        - nonprofit
        - educational
        - government
        - null
      description: The company type
      nullable: true
    NullableOfCompanyEmployees:
      enum:
        - 1-10
        - 11-50
        - 51-200
        - 201-500
        - 501-1K
        - 1K-5K
        - 5K-10K
        - over-10K
        - null
      description: The estimated employee count range
      nullable: true
    NullableOfCompanyRevenue:
      enum:
        - under-1m
        - 1m-10m
        - 10m-50m
        - 50m-100m
        - 100m-200m
        - 200m-1b
        - over-1b
        - null
      description: The estimated annual revenue range in USD
      nullable: true
    CompanyCategory:
      enum:
        - b2b
        - b2c
        - b2g
        - e-commerce
        - media
        - service-provider
        - mobile
        - saas
        - local-business
    CompanyLocationResponse:
      type: object
      properties:
        country:
          $ref: '#/components/schemas/CompanyCountryResponse'
        state:
          $ref: '#/components/schemas/CompanyStateResponse'
        city:
          $ref: '#/components/schemas/CompanyCityResponse'
        address:
          type: string
          description: The company street address
          nullable: true
        postalCode:
          type: string
          description: The company postal code
          nullable: true
        phone:
          type: string
          description: The company phone number
          nullable: true
      description: The company location and contact details
      nullable: true
    CompanySocialsResponse:
      type: object
      properties:
        linkedinUrl:
          type: string
          description: The company LinkedIn URL
          nullable: true
        linkedinId:
          type: string
          description: The company LinkedIn ID
          nullable: true
        twitterUrl:
          type: string
          description: The company Twitter/X URL
          nullable: true
        facebookUrl:
          type: string
          description: The company Facebook URL
          nullable: true
        instagramUrl:
          type: string
          description: The company Instagram URL
          nullable: true
        angellistUrl:
          type: string
          description: The company AngelList URL
          nullable: true
        crunchbaseUrl:
          type: string
          description: The company Crunchbase URL
          nullable: true
        youtubeUrl:
          type: string
          description: The company YouTube URL
          nullable: true
        githubUrl:
          type: string
          description: The company GitHub URL
          nullable: true
        g2Url:
          type: string
          description: The company G2 URL
          nullable: true
      description: The company social profiles
      nullable: true
    CompanyFinancialResponse:
      type: object
      properties:
        stockSymbol:
          type: string
          description: The company stock symbol
          nullable: true
        stockExchange:
          type: string
          description: The stock exchange where the company is listed
          nullable: true
        totalFunding:
          type: integer
          description: The total disclosed funding in USD
          format: int64
          nullable: true
        fundingStage:
          type: string
          description: The latest funding stage
          nullable: true
        fundingDate:
          type: string
          description: The date of the latest funding round
          format: date-time
          nullable: true
        fundingRounds:
          type: array
          items:
            $ref: '#/components/schemas/CompanyFundingRoundResponse'
          description: The company's disclosed funding rounds
          nullable: true
      description: >-
        Financial and funding data. Included when `financial` is requested in
        `expand`.
      nullable: true
    CompanyWorkforceResponse:
      required:
        - companyId
        - domain
        - observedEmployeeCount
        - departmentHeadcount
        - unclassifiedHeadcount
        - historyFrom
        - historyTo
      type: object
      properties:
        companyId:
          type: string
          description: The CompanyEnrich ID of the company
          format: uuid
        domain:
          type: string
          description: The canonical company domain
        observedEmployeeCount:
          type: integer
          description: >-
            The observed number of distinct current employees in the people
            dataset
          format: int32
        employeeCountRange:
          $ref: '#/components/schemas/NullableOfCompanyEmployees'
        departmentHeadcount:
          $ref: '#/components/schemas/CompanyWorkforceDepartmentResponse'
        unclassifiedHeadcount:
          type: integer
          description: Observed headcount that could not be classified by department
          format: int32
        historyFrom:
          type: string
          description: The inclusive first month of the returned 12-month history window
          format: date
        historyTo:
          type: string
          description: The exclusive end of the returned 12-month history window
          format: date
        history:
          type: array
          items:
            $ref: '#/components/schemas/CompanyWorkforceHistoryResponse'
          description: >-
            Workforce change points within the history window, newest first. A
            point at the start carries forward the last known earlier headcount
            when available.
          nullable: true
        nextCursor:
          type: string
          description: >-
            Pass this cursor with the company ID or domain to GET
            /v2/companies/workforce to fetch the preceding year for 1 credit.
            Omitted when no older history is available. Expires 30 minutes after
            the first page.
          nullable: true
      description: Workforce insights. Included when `workforce` is requested in `expand`.
      nullable: true
    CompanySearchFilter2:
      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: >-
        Filters inferred from the query and applied together with the request
        filters, in the request filter format. Omitted when none were inferred.
        Attributes the request includes values for are not inferred.
      nullable: true
    CompanySemanticBoostResponse:
      type: object
      properties:
        names:
          type: array
          items:
            type: string
          description: >-
            Company names detected in the query. A company whose name contains
            one of them, or whose domain matches it, ranks above all other
            results.
          nullable: true
        categories:
          type: array
          items:
            $ref: '#/components/schemas/CompanyCategory'
          description: A company in any of these categories ranks higher
          nullable: true
        revenue:
          type: array
          items:
            $ref: '#/components/schemas/CompanyRevenue'
          description: A company in one of these revenue ranges ranks higher
          nullable: true
      description: >-
        Attributes inferred from the query that rank matching companies higher
        without excluding or adding companies. Omitted when none were inferred.
      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
    CompanyCountryResponse:
      required:
        - code
        - name
      type: object
      properties:
        code:
          type: string
          description: The ISO 3166-1 alpha-2 country code
        name:
          type: string
          description: The country name
      description: The country where the company is located
      nullable: true
    CompanyStateResponse:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: integer
          description: The CompanyEnrich state ID
          format: int32
        name:
          type: string
          description: The state or province name
        code:
          type: string
          description: The ISO 3166-2 subdivision code
          nullable: true
      description: The state or province where the company is located
      nullable: true
    CompanyCityResponse:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: integer
          description: The CompanyEnrich city ID
          format: int32
        name:
          type: string
          description: The city name
      description: The city where the company is located
      nullable: true
    CompanyFundingRoundResponse:
      type: object
      properties:
        date:
          type: string
          description: The funding round date
          format: date-time
          nullable: true
        amount:
          type: string
          description: The disclosed funding amount and currency
          nullable: true
        type:
          type: string
          description: The funding round type
          nullable: true
        url:
          type: string
          description: A source URL for the funding round
          nullable: true
        investors:
          type: string
          description: The disclosed investors
          nullable: true
    CompanyWorkforceDepartmentResponse:
      type: object
      properties:
        cSuite:
          type: integer
          description: Observed c-suite headcount
          format: int32
          nullable: true
        productManagement:
          type: integer
          description: Observed product management headcount
          format: int32
          nullable: true
        engineeringTechnical:
          type: integer
          description: Observed engineering and technical headcount
          format: int32
          nullable: true
        design:
          type: integer
          description: Observed design headcount
          format: int32
          nullable: true
        education:
          type: integer
          description: Observed education headcount
          format: int32
          nullable: true
        finance:
          type: integer
          description: Observed finance headcount
          format: int32
          nullable: true
        humanResources:
          type: integer
          description: Observed human resources headcount
          format: int32
          nullable: true
        informationTechnology:
          type: integer
          description: Observed information technology headcount
          format: int32
          nullable: true
        legal:
          type: integer
          description: Observed legal headcount
          format: int32
          nullable: true
        marketing:
          type: integer
          description: Observed marketing headcount
          format: int32
          nullable: true
        medicalHealth:
          type: integer
          description: Observed medical and health headcount
          format: int32
          nullable: true
        operations:
          type: integer
          description: Observed operations headcount
          format: int32
          nullable: true
        sales:
          type: integer
          description: Observed sales headcount
          format: int32
          nullable: true
        consulting:
          type: integer
          description: Observed consulting headcount
          format: int32
          nullable: true
      description: Observed headcount grouped by department
    CompanyWorkforceHistoryResponse:
      required:
        - date
        - observedEmployeeCount
        - departmentHeadcount
        - unclassifiedHeadcount
      type: object
      properties:
        date:
          type: string
          description: The first day of the snapshot month
          format: date
        observedEmployeeCount:
          type: integer
          description: The observed number of distinct employees in the people dataset
          format: int32
        employeeCountRange:
          $ref: '#/components/schemas/NullableOfCompanyEmployees'
        departmentHeadcount:
          $ref: '#/components/schemas/CompanyWorkforceDepartmentResponse'
        unclassifiedHeadcount:
          type: integer
          description: Observed headcount that could not be classified by department
          format: int32
    CompanyRevenue:
      enum:
        - under-1m
        - 1m-10m
        - 10m-50m
        - 50m-100m
        - 100m-200m
        - 200m-1b
        - over-1b
  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.