> ## 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. # Count matching companies > Counts companies using the same filters, semantic query, and lookalike query as the search endpoint, without pagination or response expansions. Send an empty object (`{}`) to count companies without filters. This endpoint does not consume credits. `count` is limited by the current plan; `total` is the matching search population before plan limits. Semantic and lookalike totals refer to the vector search candidate pool. Semantic queries infer company attributes as in search and report them in `interpretation`. ## OpenAPI ````yaml openapi/v2.json POST /v2/companies/search/count 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/count: post: tags: - Company / Search summary: Count matching companies description: >- Counts companies using the same filters, semantic query, and lookalike query as the search endpoint, without pagination or response expansions. Send an empty object (`{}`) to count companies without filters. This endpoint does not consume credits. `count` is limited by the current plan; `total` is the matching search population before plan limits. Semantic and lookalike totals refer to the vector search candidate pool. Semantic queries infer company attributes as in search and report them in `interpretation`. requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanySearchQuery2' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CompanySearchCountV2Response' '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' '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: CompanySearchQuery2: type: object properties: filter: $ref: '#/components/schemas/CompanySearchFilter' semantic: $ref: '#/components/schemas/CompanySemanticQuery' lookalike: $ref: '#/components/schemas/CompanyLookalikeQuery' CompanySearchCountV2Response: required: - count - total type: object properties: count: type: integer description: The number of matching companies accessible under the current plan format: int32 total: type: integer description: >- The total number of matching companies before plan limits are applied format: int32 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 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 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 CompanyCategory: enum: - b2b - b2c - b2g - e-commerce - media - service-provider - mobile - saas - local-business 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.