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

# Filter Search Capabilities

> Get the fields, operators, and limits supported by filter search.



## OpenAPI

````yaml https://api.sixtyfour.ai/openapi.json get /search/filter-capabilities
openapi: 3.1.0
info:
  title: Sixtyfour API
  description: >-
    Intelligence API for People and Entities. Deploy AI agents that investigate,
    resolve identities, map relationships, and surface risk signals
  contact:
    name: Sixtyfour
    url: https://sixtyfour.ai/
    email: support@sixtyfour.ai
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api.sixtyfour.ai
    description: Production
security: []
tags:
  - name: Enrichment
    description: Find and enrich emails, phones, and LinkedIn for people and companies.
  - name: org-chart
    description: Discover people inside a company and build org charts.
  - name: Search
    description: Run deep and filter searches over Sixtyfour's data.
  - name: Workflow
    description: Create, run, and manage enrichment workflows.
  - name: Workflow Schedules
    description: Create and manage recurring schedules for workflows.
  - name: Account
    description: Manage and inspect your account and credit balance.
  - name: Intelligence
    description: Verify identity attributes such as age using high-tier OSINT research.
paths:
  /search/filter-capabilities:
    get:
      tags:
        - Search
      summary: Filter Search Capabilities
      description: Get the fields, operators, and limits supported by filter search.
      operationId: get_filter_capabilities_endpoint_search_filter_capabilities_get
      parameters:
        - name: mode
          in: query
          required: false
          schema:
            type: string
            description: 'Search mode: ''company'' or ''people''.'
            default: company
            title: Mode
          description: 'Search mode: ''company'' or ''people''.'
        - name: refresh
          in: query
          required: false
          schema:
            type: boolean
            description: Force a mapping refresh instead of using cached capabilities.
            default: false
            title: Refresh
          description: Force a mapping refresh instead of using cached capabilities.
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterSearchCapabilitiesResponse'
        '400':
          description: Request was rejected by the route's validation rules.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Invalid request body
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Invalid API key
        '402':
          description: >-
            Insufficient credits or no active subscription for this
            organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Insufficient API credits
        '403':
          description: Forwarded user_id does not belong to caller's organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Forwarded user_id does not belong to your organization.
        '404':
          description: Search task or export file not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Search not found or has no parsed_query.
        '409':
          description: Export workflow already running for this search.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Export workflow is already running for this search.
        '422':
          description: Request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Rate limit exceeded
        '500':
          description: Unexpected server error. Retry with backoff.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Internal server error
        '502':
          description: Upstream search backend returned an error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: 'NL upstream transport error: connection reset by peer'
        '503':
          description: Search backend is not configured or unavailable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Company search backend endpoint is not configured
        '504':
          description: Upstream search backend timed out.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: Field values request timed out
components:
  schemas:
    FilterSearchCapabilitiesResponse:
      properties:
        mode:
          type: string
          enum:
            - people
            - company
          title: Mode
          description: Search mode these capabilities apply to.
          default: company
        index_name:
          type: string
          title: Index Name
          description: Public dataset identifier for company direct-filter queries.
        fields:
          items:
            $ref: '#/components/schemas/FilterFieldCapability'
          type: array
          title: Fields
          description: Unified per-field capabilities sorted alphabetically.
        nested_paths:
          items:
            type: string
          type: array
          title: Nested Paths
          description: Allowed nested.path values for nested query clauses.
        limits:
          $ref: '#/components/schemas/FilterSearchLimits'
        cache_ttl_seconds:
          type: integer
          title: Cache Ttl Seconds
          description: Server cache TTL for mapping-derived capabilities.
        generated_at_epoch_ms:
          type: integer
          title: Generated At Epoch Ms
          description: Epoch timestamp (ms) when these capabilities were derived.
        mapping_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Mapping Hash
          description: Hash of mapping metadata used to derive this capability snapshot.
        simple_query_operators:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Simple Query Operators
          description: Supported MongoDB-style operators for simple_filters input.
      type: object
      required:
        - index_name
        - fields
        - nested_paths
        - limits
        - cache_ttl_seconds
        - generated_at_epoch_ms
      title: FilterSearchCapabilitiesResponse
      description: Response describing supported filter-search DSL capabilities.
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      example:
        detail:
          - loc:
              - body
              - target_company
              - domain
            msg: Field required
            type: missing
            input: null
            ctx: {}
    FilterFieldCapability:
      properties:
        field:
          type: string
          title: Field
          description: Canonical field path.
        field_type:
          type: string
          title: Field Type
          description: Source ES mapping type (e.g. text, keyword, long).
        nested_path:
          anyOf:
            - type: string
            - type: 'null'
          title: Nested Path
          description: Nested path, if any.
        queryable:
          type: boolean
          title: Queryable
          description: Allowed in query clauses.
        sortable:
          type: boolean
          title: Sortable
          description: Allowed in sort clauses.
        rangeable:
          type: boolean
          title: Rangeable
          description: Supports range operators (gt/gte/lt/lte).
        sort_field:
          anyOf:
            - type: string
            - type: 'null'
          title: Sort Field
          description: >-
            Sort target when it differs from field (e.g. text fields sort via
            .keyword).
        aggregation_field:
          anyOf:
            - type: string
            - type: 'null'
          title: Aggregation Field
          description: Field used for terms aggregation when supports_top_values is true.
        value_type:
          type: string
          title: Value Type
          description: Aggregation target type (keyword, long, etc.).
        supports_top_values:
          type: boolean
          title: Supports Top Values
          description: Supports top-values aggregation.
        supports_exact_filter_snippet:
          type: boolean
          title: Supports Exact Filter Snippet
          description: API can return deterministic exact filter snippets.
        related_fields:
          items:
            type: string
          type: array
          title: Related Fields
          description: >-
            Other paths representing the same concept (e.g. flat counterpart of
            nested).
        preferred_for_exact_match:
          type: boolean
          title: Preferred For Exact Match
          description: >-
            Recommended for simple exact-match queries over its nested
            counterpart.
          default: false
      type: object
      required:
        - field
        - field_type
        - queryable
        - sortable
        - rangeable
        - value_type
        - supports_top_values
        - supports_exact_filter_snippet
      title: FilterFieldCapability
      description: Unified per-field capability descriptor for filter-search clients.
    FilterSearchLimits:
      properties:
        max_query_depth:
          type: integer
          title: Max Query Depth
          description: Maximum recursive query depth.
        max_clause_count:
          type: integer
          title: Max Clause Count
          description: Maximum total query clauses.
        max_terms_per_clause:
          type: integer
          title: Max Terms Per Clause
          description: Maximum values in terms/bool lists.
        max_sort_clauses:
          type: integer
          title: Max Sort Clauses
          description: Maximum sort clauses.
        max_string_length:
          type: integer
          title: Max String Length
          description: Maximum string length in query values.
      type: object
      required:
        - max_query_depth
        - max_clause_count
        - max_terms_per_clause
        - max_sort_clauses
        - max_string_length
      title: FilterSearchLimits
      description: Constraint values for guarded DSL validation.
    ValidationError:
      title: ValidationError
      type: object
      required:
        - loc
        - msg
        - type
      properties:
        loc:
          type: array
          items:
            oneOf:
              - type: string
              - type: integer
          description: Path to the field that failed validation.
          example:
            - body
            - target_company
            - domain
        msg:
          type: string
          description: Human-readable error message.
          example: Field required
        type:
          type: string
          description: Error code (e.g. 'missing', 'value_error').
          example: missing
        input:
          description: The offending input value (any type, may be null).
          nullable: true
          example: null
        ctx:
          type: object
          description: Optional error context.
          additionalProperties: true
          example: {}

````