Freshworks Freshsales API — Leads

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshsales API — Leads
  description: 'Freshworks Freshsales API — Leads. 5 operations. Lead operation: List all leads. Self-contained Naftiko capability
    covering one Freshworks business surface.'
  tags:
  - Freshworks
  - Leads
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHWORKS_API_KEY: FRESHWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: freshsales-leads
    baseUri: https://{domain}.myfreshworks.com/crm/sales/api
    description: Freshworks Freshsales API — Leads business capability. Self-contained, no shared references.
    resources:
    - name: leads
      path: /leads
      operations:
      - name: listleads
        method: GET
        description: List all leads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createlead
        method: POST
        description: Create a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: leads-lead_id
      path: /leads/{lead_id}
      operations:
      - name: getlead
        method: GET
        description: View a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatelead
        method: PUT
        description: Update a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletelead
        method: DELETE
        description: Delete a lead
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.FRESHWORKS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: freshsales-leads-rest
    port: 8080
    description: REST adapter for Freshworks Freshsales API — Leads. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/leads
      name: leads
      description: REST surface for leads.
      operations:
      - method: GET
        name: listleads
        description: List all leads
        call: freshsales-leads.listleads
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createlead
        description: Create a lead
        call: freshsales-leads.createlead
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/leads/{lead-id}
      name: leads-lead-id
      description: REST surface for leads-lead_id.
      operations:
      - method: GET
        name: getlead
        description: View a lead
        call: freshsales-leads.getlead
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatelead
        description: Update a lead
        call: freshsales-leads.updatelead
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletelead
        description: Delete a lead
        call: freshsales-leads.deletelead
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshsales-leads-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshsales API — Leads. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-leads
      description: List all leads
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshsales-leads.listleads
      outputParameters:
      - type: object
        mapping: $.
    - name: create-lead
      description: Create a lead
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshsales-leads.createlead
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-lead
      description: View a lead
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshsales-leads.getlead
      outputParameters:
      - type: object
        mapping: $.
    - name: update-lead
      description: Update a lead
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshsales-leads.updatelead
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-lead
      description: Delete a lead
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: freshsales-leads.deletelead
      outputParameters:
      - type: object
        mapping: $.