Freshdesk REST API — Search

naftiko: 1.0.0-alpha2
info:
  label: Freshdesk REST API — Search
  description: 'Freshdesk REST API — Search. 3 operations. Lead operation: Search companies. Self-contained Naftiko capability
    covering one Freshdesk business surface.'
  tags:
  - Freshdesk
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHDESK_API_KEY: FRESHDESK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-search
    baseUri: https://{domain}.freshdesk.com/api/v2
    description: Freshdesk REST API — Search business capability. Self-contained, no shared references.
    resources:
    - name: search-companies
      path: /search/companies
      operations:
      - name: searchcompanies
        method: GET
        description: Search companies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: Search query using Freshdesk query language.
          required: true
    - name: search-contacts
      path: /search/contacts
      operations:
      - name: searchcontacts
        method: GET
        description: Search contacts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: Search query using Freshdesk query language.
          required: true
    - name: search-tickets
      path: /search/tickets
      operations:
      - name: searchtickets
        method: GET
        description: Search tickets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
          description: Search query using Freshdesk query language, e.g. "priority:1 AND status:2".
          required: true
    authentication:
      type: basic
      username: '{{env.FRESHDESK_USER}}'
      password: '{{env.FRESHDESK_PASS}}'
  exposes:
  - type: rest
    namespace: rest-search-rest
    port: 8080
    description: REST adapter for Freshdesk REST API — Search. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/search/companies
      name: search-companies
      description: REST surface for search-companies.
      operations:
      - method: GET
        name: searchcompanies
        description: Search companies
        call: rest-search.searchcompanies
        with:
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/contacts
      name: search-contacts
      description: REST surface for search-contacts.
      operations:
      - method: GET
        name: searchcontacts
        description: Search contacts
        call: rest-search.searchcontacts
        with:
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search/tickets
      name: search-tickets
      description: REST surface for search-tickets.
      operations:
      - method: GET
        name: searchtickets
        description: Search tickets
        call: rest-search.searchtickets
        with:
          query: rest.query
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshdesk REST API — Search. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: search-companies
      description: Search companies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-search.searchcompanies
      with:
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: search-contacts
      description: Search contacts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-search.searchcontacts
      with:
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.
    - name: search-tickets
      description: Search tickets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-search.searchtickets
      with:
        query: tools.query
      outputParameters:
      - type: object
        mapping: $.