openapi: 3.2.0
info:
  title: Relm CRM Search API
  version: 0.17.1
  summary: API-first CRM built for LLMs and AI agents.
  description: REST surface for Relm.
  contact:
    name: Relm
    url: https://relmcrm.com/
  license:
    name: Proprietary
servers:
- url: https://api.relmcrm.com/v1
  description: Production
security:
- bearerAuth: []
- oauth2:
  - crm
tags:
- name: Search
paths:
  /search:
    get:
      tags:
      - Search
      operationId: search
      summary: Cross-object search over contacts, companies and deals
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
        description: Substring to match.
      - name: limit
        in: query
        schema:
          type: integer
          default: 10
          maximum: 100
      responses:
        '200':
          description: Search results (has_more=true if any section was truncated).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResult'
        default:
          $ref: '#/components/responses/Problem'
components:
  responses:
    Problem:
      description: RFC-9457 problem+json error.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  schemas:
    SearchResult:
      type: object
      properties:
        object:
          type: string
          const: search
        query:
          type: string
        has_more:
          type: boolean
        results:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              id:
                type: string
              title:
                type: string
    Problem:
      type: object
      description: RFC-9457 error. Closed-set rejections carry valid_options + suggestion so an agent self-corrects.
      properties:
        type:
          type: string
          format: uri
          example: https://relmcrm.com/errors/unknown_value
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
          example: unknown_value
        field:
          type: string
        valid_options:
          type: array
          items:
            type: string
        suggestion:
          type: string
        request_id:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Workspace-scoped API key. relm_live_... (live) or relm_test_... (free, isolated test mode). Mint at https://app.relmcrm.com/.
    oauth2:
      type: oauth2
      description: 'OAuth 2.1 with PKCE (S256) and dynamic client registration (RFC 7591). Live mode only; test mode is API-key only. Discovery: /.well-known/oauth-authorization-server.'
      flows:
        authorizationCode:
          authorizationUrl: https://api.relmcrm.com/oauth/authorize
          tokenUrl: https://api.relmcrm.com/oauth/token
          refreshUrl: https://api.relmcrm.com/oauth/token
          scopes:
            crm: Read and write the connected Relm workspace