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

# Search customers

> Search for customers using semantic similarity search based on the query text.



## OpenAPI

````yaml GET /customer/search/{query}
openapi: 3.1.0
info:
  title: DocOpsAI API
  version: 0.1.0
  description: >
    AI-based order processing application that extracts information from email
    attachments and forwards to backend systems. Provides endpoints for order
    management, customer and product CRUD, email watching, and template
    parameter configuration.
  contact:
    name: DevOps Company
servers:
  - url: https://start.aiotic.ai
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: healthcheck
    description: Service health monitoring
  - name: order
    description: Order document upload and processing
  - name: order_status
    description: Order processing status tracking
  - name: customer
    description: Customer record management with vector search
  - name: product
    description: Product record management
  - name: template_parameters
    description: Prompt template parameter management
  - name: email-watcher
    description: Email inbox monitoring and processing
paths:
  /customer/search/{query}:
    get:
      tags:
        - customer
      summary: Search customers
      description: >-
        Search for customers using semantic similarity search based on the query
        text.
      operationId: searchCustomers
      parameters:
        - name: query
          in: path
          required: true
          description: Search query text
          schema:
            type: string
        - name: top_k
          in: query
          required: false
          description: Number of top results to return
          schema:
            type: integer
            default: 10
            minimum: 1
            maximum: 1000
      responses:
        '200':
          description: Customers matching the search query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerSearchResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CustomerSearchResponse:
      type: object
      required:
        - items
        - total
        - limit
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
          description: List of customer objects with similarity scores
        total:
          type: integer
          description: Total number of customers in the system
        limit:
          type: integer
          description: Maximum number of customers returned
    ErrorResponse:
      type: object
      required:
        - detail
      properties:
        detail:
          type: string
          description: Error message describing what went wrong
    Customer:
      type: object
      required:
        - number
      properties:
        number:
          type: string
          description: Customer number (external, unique)
        id:
          type: string
          format: uuid
          description: Unique customer identifier
        name:
          type: string
          nullable: true
          description: Company name
        postal_code:
          type: string
          nullable: true
          description: Postal code
        city:
          type: string
          nullable: true
          description: City
        address:
          type: string
          nullable: true
          description: Street address
        contact_person:
          type: string
          nullable: true
          description: Primary contact person
        phone_number:
          type: string
          nullable: true
          description: Phone number
        vat_number:
          type: string
          nullable: true
          description: VAT/BTW number
        email:
          type: string
          nullable: true
          description: Customer email address
        coc_number:
          type: string
          nullable: true
          description: Chamber of Commerce number
        home_page:
          type: string
          nullable: true
          description: Company website URL
        similarity:
          type: number
          format: float
          nullable: true
          description: Similarity score (only populated in search results, 0.0 to 1.0)
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >
        API key for authentication. Required on all endpoints except
        /healthcheck. Customer and product endpoints also accept a
        customer-specific API key.

````