Freshworks Freshsales API — Accounts

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