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

# Search across customers, segments and campaigns

> Relevance-ranked, fuzzy. A query may match a substring, a word prefix or (for three or more characters) a trigram-similar phrase; the signal is accent-insensitive, so typography cannot hide a match. Results mix all three record types sorted by score, which the palette mirrors as grouped sections. Every result answers with a `score`, the client-facing rank, never with an SQL value.



## OpenAPI

````yaml /reference/openapi.json get /v1/search
openapi: 3.1.0
info:
  title: Campaign Assistant API
  version: v1
  summary: Campaign drafting over a shared, runtime-validated contract.
  description: >-
    Every endpoint below is described by the shared contract package: the
    request and response schemas served here are the ones the web app validates
    against at runtime.


    Authentication is a bearer access token obtained from `auth.signIn`. Errors
    are always an RFC 9457 problem document. Chat replies can be streamed as
    server-sent events; see `chat.messages.stream`.
  license:
    name: UNLICENSED
    identifier: UNLICENSED
servers:
  - url: http://localhost:4000/api/v1
    description: This deployment
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Sign-in, token rotation and sign-out.
  - name: Customers
    description: 'The customer base: records, aggregates and bulk import.'
  - name: Segments
    description: Saved audience definitions and live audience counts.
  - name: Campaigns
    description: Model-assisted campaign drafting and its review workflow.
  - name: Chat
    description: Assistant threads, including server-sent streaming of replies.
paths:
  /v1/search:
    get:
      tags:
        - Search
      summary: Search across customers, segments and campaigns
      description: >-
        Relevance-ranked, fuzzy. A query may match a substring, a word prefix or
        (for three or more characters) a trigram-similar phrase; the signal is
        accent-insensitive, so typography cannot hide a match. Results mix all
        three record types sorted by score, which the palette mirrors as grouped
        sections. Every result answers with a `score`, the client-facing rank,
        never with an SQL value.
      operationId: search.global
      parameters:
        - name: q
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 120
        - name: limit
          in: query
          required: false
          schema:
            default: 8
            type: integer
            minimum: 1
            maximum: 24
      responses:
        '200':
          description: OK
          headers:
            x-api-version:
              $ref: '#/components/headers/ApiVersion'
          content:
            application/json:
              schema:
                type: object
                properties:
                  query:
                    type: string
                    minLength: 1
                  total:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  tookMs:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - customer
                            - segment
                            - campaign
                        id:
                          type: string
                          minLength: 1
                        title:
                          type: string
                          minLength: 1
                        subtitle:
                          anyOf:
                            - type: string
                            - type: 'null'
                        meta:
                          anyOf:
                            - type: string
                            - type: 'null'
                        score:
                          type: number
                          minimum: 0
                      required:
                        - type
                        - id
                        - title
                        - subtitle
                        - meta
                        - score
                      additionalProperties: false
                required:
                  - query
                  - total
                  - tookMs
                  - results
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth: []
components:
  headers:
    ApiVersion:
      description: The API version that answered this request.
      schema:
        type: string
        const: v1
        examples:
          - v1
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        detail:
          type: string
        code:
          type: string
          enum:
            - validation_failed
            - invalid_credentials
            - unauthenticated
            - session_expired
            - forbidden
            - not_found
            - conflict
            - rate_limited
            - llm_unavailable
            - llm_error
            - internal_error
        errors:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: array
            items:
              type: string
        traceId:
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by `auth.signIn`. Expires; refresh it with
        `auth.refresh`.

````

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