Freshdesk REST API — Groups

naftiko: 1.0.0-alpha2
info:
  label: Freshdesk REST API — Groups
  description: 'Freshdesk REST API — Groups. 5 operations. Lead operation: List all groups. Self-contained Naftiko capability
    covering one Freshdesk business surface.'
  tags:
  - Freshdesk
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRESHDESK_API_KEY: FRESHDESK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-groups
    baseUri: https://{domain}.freshdesk.com/api/v2
    description: Freshdesk REST API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: groups
      path: /groups
      operations:
      - name: listgroups
        method: GET
        description: List all groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: creategroup
        method: POST
        description: Create a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-group_id
      path: /groups/{group_id}
      operations:
      - name: getgroup
        method: GET
        description: View a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategroup
        method: PUT
        description: Update a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletegroup
        method: DELETE
        description: Delete a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.FRESHDESK_USER}}'
      password: '{{env.FRESHDESK_PASS}}'
  exposes:
  - type: rest
    namespace: rest-groups-rest
    port: 8080
    description: REST adapter for Freshdesk REST API — Groups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/groups
      name: groups
      description: REST surface for groups.
      operations:
      - method: GET
        name: listgroups
        description: List all groups
        call: rest-groups.listgroups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategroup
        description: Create a group
        call: rest-groups.creategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{group-id}
      name: groups-group-id
      description: REST surface for groups-group_id.
      operations:
      - method: GET
        name: getgroup
        description: View a group
        call: rest-groups.getgroup
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updategroup
        description: Update a group
        call: rest-groups.updategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroup
        description: Delete a group
        call: rest-groups.deletegroup
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freshdesk REST API — Groups. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-all-groups
      description: List all groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-groups.listgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: create-group
      description: Create a group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-groups.creategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-group
      description: View a group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-groups.getgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: update-group
      description: Update a group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-groups.updategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-group
      description: Delete a group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-groups.deletegroup
      outputParameters:
      - type: object
        mapping: $.