Core API — Teammate groups

naftiko: 1.0.0-alpha2
info:
  label: Core API — Teammate groups
  description: 'Core API — Teammate groups. 14 operations. Lead operation: List teammate groups. Self-contained Naftiko capability
    covering one Front business surface.'
  tags:
  - Front
  - Teammate groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRONT_API_KEY: FRONT_API_KEY
capability:
  consumes:
  - type: http
    namespace: core-teammate-groups
    baseUri: https://api2.frontapp.com
    description: Core API — Teammate groups business capability. Self-contained, no shared references.
    resources:
    - name: teammate_groups
      path: /teammate_groups
      operations:
      - name: listcompanyteammategroups
        method: GET
        description: List teammate groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcompanyteammategroup
        method: POST
        description: Create teammate group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: teammate_groups-teammate_group_id
      path: /teammate_groups/{teammate_group_id}
      operations:
      - name: getcompanyteammategroup
        method: GET
        description: Get teammate group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
      - name: updateacompanyteammategroup
        method: PATCH
        description: Update a teammate group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecompanyteammategroup
        method: DELETE
        description: Delete teammate group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
    - name: teammate_groups-teammate_group_id-inboxes
      path: /teammate_groups/{teammate_group_id}/inboxes
      operations:
      - name: listcompanyteammategroupteaminboxes
        method: GET
        description: List teammate group team inboxes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
      - name: addcompanyteammategroupteaminboxes
        method: POST
        description: Add teammate group team inboxes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: removecompanyteammategroupteaminboxes
        method: DELETE
        description: Remove teammate group team inboxes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: teammate_groups-teammate_group_id-teammates
      path: /teammate_groups/{teammate_group_id}/teammates
      operations:
      - name: listcompanyteammategroupteammates
        method: GET
        description: List teammate group teammates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
      - name: addcompanyteammategroupteammates
        method: POST
        description: Add teammate group teammates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: removecompanyteammategroupteammates
        method: DELETE
        description: Remove teammate group teammates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: teammate_groups-teammate_group_id-teams
      path: /teammate_groups/{teammate_group_id}/teams
      operations:
      - name: listcompanyteammategroupteams
        method: GET
        description: List teammate group teams
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
      - name: addcompanyteammategroupteams
        method: POST
        description: Add teammate group teams
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: removecompanyteammategroupteams
        method: DELETE
        description: Remove teammate group teams
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: teammate_group_id
          in: path
          type: string
          description: The teammate group ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.FRONT_API_KEY}}'
  exposes:
  - type: rest
    namespace: core-teammate-groups-rest
    port: 8080
    description: REST adapter for Core API — Teammate groups. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/teammate-groups
      name: teammate-groups
      description: REST surface for teammate_groups.
      operations:
      - method: GET
        name: listcompanyteammategroups
        description: List teammate groups
        call: core-teammate-groups.listcompanyteammategroups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcompanyteammategroup
        description: Create teammate group
        call: core-teammate-groups.createcompanyteammategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/teammate-groups/{teammate-group-id}
      name: teammate-groups-teammate-group-id
      description: REST surface for teammate_groups-teammate_group_id.
      operations:
      - method: GET
        name: getcompanyteammategroup
        description: Get teammate group
        call: core-teammate-groups.getcompanyteammategroup
        with:
          teammate_group_id: rest.teammate_group_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateacompanyteammategroup
        description: Update a teammate group
        call: core-teammate-groups.updateacompanyteammategroup
        with:
          teammate_group_id: rest.teammate_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecompanyteammategroup
        description: Delete teammate group
        call: core-teammate-groups.deletecompanyteammategroup
        with:
          teammate_group_id: rest.teammate_group_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/teammate-groups/{teammate-group-id}/inboxes
      name: teammate-groups-teammate-group-id-inboxes
      description: REST surface for teammate_groups-teammate_group_id-inboxes.
      operations:
      - method: GET
        name: listcompanyteammategroupteaminboxes
        description: List teammate group team inboxes
        call: core-teammate-groups.listcompanyteammategroupteaminboxes
        with:
          teammate_group_id: rest.teammate_group_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addcompanyteammategroupteaminboxes
        description: Add teammate group team inboxes
        call: core-teammate-groups.addcompanyteammategroupteaminboxes
        with:
          teammate_group_id: rest.teammate_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removecompanyteammategroupteaminboxes
        description: Remove teammate group team inboxes
        call: core-teammate-groups.removecompanyteammategroupteaminboxes
        with:
          teammate_group_id: rest.teammate_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/teammate-groups/{teammate-group-id}/teammates
      name: teammate-groups-teammate-group-id-teammates
      description: REST surface for teammate_groups-teammate_group_id-teammates.
      operations:
      - method: GET
        name: listcompanyteammategroupteammates
        description: List teammate group teammates
        call: core-teammate-groups.listcompanyteammategroupteammates
        with:
          teammate_group_id: rest.teammate_group_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addcompanyteammategroupteammates
        description: Add teammate group teammates
        call: core-teammate-groups.addcompanyteammategroupteammates
        with:
          teammate_group_id: rest.teammate_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removecompanyteammategroupteammates
        description: Remove teammate group teammates
        call: core-teammate-groups.removecompanyteammategroupteammates
        with:
          teammate_group_id: rest.teammate_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/teammate-groups/{teammate-group-id}/teams
      name: teammate-groups-teammate-group-id-teams
      description: REST surface for teammate_groups-teammate_group_id-teams.
      operations:
      - method: GET
        name: listcompanyteammategroupteams
        description: List teammate group teams
        call: core-teammate-groups.listcompanyteammategroupteams
        with:
          teammate_group_id: rest.teammate_group_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addcompanyteammategroupteams
        description: Add teammate group teams
        call: core-teammate-groups.addcompanyteammategroupteams
        with:
          teammate_group_id: rest.teammate_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removecompanyteammategroupteams
        description: Remove teammate group teams
        call: core-teammate-groups.removecompanyteammategroupteams
        with:
          teammate_group_id: rest.teammate_group_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: core-teammate-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Core API — Teammate groups. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-teammate-groups
      description: List teammate groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-teammate-groups.listcompanyteammategroups
      outputParameters:
      - type: object
        mapping: $.
    - name: create-teammate-group
      description: Create teammate group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: core-teammate-groups.createcompanyteammategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-teammate-group
      description: Get teammate group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-teammate-groups.getcompanyteammategroup
      with:
        teammate_group_id: tools.teammate_group_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-teammate-group
      description: Update a teammate group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: core-teammate-groups.updateacompanyteammategroup
      with:
        teammate_group_id: tools.teammate_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-teammate-group
      description: Delete teammate group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: core-teammate-groups.deletecompanyteammategroup
      with:
        teammate_group_id: tools.teammate_group_id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-teammate-group-team-inboxes
      description: List teammate group team inboxes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-teammate-groups.listcompanyteammategroupteaminboxes
      with:
        teammate_group_id: tools.teammate_group_id
      outputParameters:
      - type: object
        mapping: $.
    - name: add-teammate-group-team-inboxes
      description: Add teammate group team inboxes
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: core-teammate-groups.addcompanyteammategroupteaminboxes
      with:
        teammate_group_id: tools.teammate_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-teammate-group-team-inboxes
      description: Remove teammate group team inboxes
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: core-teammate-groups.removecompanyteammategroupteaminboxes
      with:
        teammate_group_id: tools.teammate_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-teammate-group-teammates
      description: List teammate group teammates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-teammate-groups.listcompanyteammategroupteammates
      with:
        teammate_group_id: tools.teammate_group_id
      outputParameters:
      - type: object
        mapping: $.
    - name: add-teammate-group-teammates
      description: Add teammate group teammates
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: core-teammate-groups.addcompanyteammategroupteammates
      with:
        teammate_group_id: tools.teammate_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-teammate-group-teammates
      description: Remove teammate group teammates
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: core-teammate-groups.removecompanyteammategroupteammates
      with:
        teammate_group_id: tools.teammate_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-teammate-group-teams
      description: List teammate group teams
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-teammate-groups.listcompanyteammategroupteams
      with:
        teammate_group_id: tools.teammate_group_id
      outputParameters:
      - type: object
        mapping: $.
    - name: add-teammate-group-teams
      description: Add teammate group teams
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: core-teammate-groups.addcompanyteammategroupteams
      with:
        teammate_group_id: tools.teammate_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-teammate-group-teams
      description: Remove teammate group teams
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: core-teammate-groups.removecompanyteammategroupteams
      with:
        teammate_group_id: tools.teammate_group_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.