Freshworks Freshsales API — Tasks

naftiko: 1.0.0-alpha2
info:
  label: Freshworks Freshsales API — Tasks
  description: 'Freshworks Freshsales API — Tasks. 5 operations. Lead operation: List all tasks. Self-contained Naftiko capability
    covering one Freshworks business surface.'
  tags:
  - Freshworks
  - Tasks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHWORKS_API_KEY: FRESHWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: freshsales-tasks
    baseUri: https://{domain}.myfreshworks.com/crm/sales/api
    description: Freshworks Freshsales API — Tasks business capability. Self-contained, no shared references.
    resources:
    - name: tasks
      path: /tasks
      operations:
      - name: listtasks
        method: GET
        description: List all tasks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Filter tasks by status (open, due_today, due_tomorrow, overdue, completed).
      - name: createtask
        method: POST
        description: Create a task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: tasks-task_id
      path: /tasks/{task_id}
      operations:
      - name: gettask
        method: GET
        description: View a task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatetask
        method: PUT
        description: Update a task
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletetask
        method: DELETE
        description: Delete a task
        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-tasks-rest
    port: 8080
    description: REST adapter for Freshworks Freshsales API — Tasks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/tasks
      name: tasks
      description: REST surface for tasks.
      operations:
      - method: GET
        name: listtasks
        description: List all tasks
        call: freshsales-tasks.listtasks
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createtask
        description: Create a task
        call: freshsales-tasks.createtask
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tasks/{task-id}
      name: tasks-task-id
      description: REST surface for tasks-task_id.
      operations:
      - method: GET
        name: gettask
        description: View a task
        call: freshsales-tasks.gettask
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatetask
        description: Update a task
        call: freshsales-tasks.updatetask
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletetask
        description: Delete a task
        call: freshsales-tasks.deletetask
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: freshsales-tasks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshworks Freshsales API — Tasks. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-tasks
      description: List all tasks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshsales-tasks.listtasks
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: create-task
      description: Create a task
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: freshsales-tasks.createtask
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-task
      description: View a task
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: freshsales-tasks.gettask
      outputParameters:
      - type: object
        mapping: $.
    - name: update-task
      description: Update a task
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: freshsales-tasks.updatetask
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-task
      description: Delete a task
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: freshsales-tasks.deletetask
      outputParameters:
      - type: object
        mapping: $.