Iterable REST API — Lists

naftiko: 1.0.0-alpha2
info:
  label: Iterable REST API — Lists
  description: 'Iterable REST API — Lists. 4 operations. Lead operation: Get all lists. Self-contained Naftiko capability
    covering one Iterable business surface.'
  tags:
  - Iterable
  - Lists
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ITERABLE_API_KEY: ITERABLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-lists
    baseUri: https://api.iterable.com/api
    description: Iterable REST API — Lists business capability. Self-contained, no shared references.
    resources:
    - name: lists
      path: /lists
      operations:
      - name: listlists
        method: GET
        description: Get all lists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createlist
        method: POST
        description: Create a list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: lists-subscribe
      path: /lists/subscribe
      operations:
      - name: subscribetolist
        method: POST
        description: Subscribe users to a list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: lists-unsubscribe
      path: /lists/unsubscribe
      operations:
      - name: unsubscribefromlist
        method: POST
        description: Unsubscribe users from a list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Api-Key
      value: '{{env.ITERABLE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-lists-rest
    port: 8080
    description: REST adapter for Iterable REST API — Lists. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/lists
      name: lists
      description: REST surface for lists.
      operations:
      - method: GET
        name: listlists
        description: Get all lists
        call: rest-lists.listlists
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createlist
        description: Create a list
        call: rest-lists.createlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lists/subscribe
      name: lists-subscribe
      description: REST surface for lists-subscribe.
      operations:
      - method: POST
        name: subscribetolist
        description: Subscribe users to a list
        call: rest-lists.subscribetolist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lists/unsubscribe
      name: lists-unsubscribe
      description: REST surface for lists-unsubscribe.
      operations:
      - method: POST
        name: unsubscribefromlist
        description: Unsubscribe users from a list
        call: rest-lists.unsubscribefromlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-lists-mcp
    port: 9090
    transport: http
    description: MCP adapter for Iterable REST API — Lists. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-all-lists
      description: Get all lists
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-lists.listlists
      outputParameters:
      - type: object
        mapping: $.
    - name: create-list
      description: Create a list
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-lists.createlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: subscribe-users-list
      description: Subscribe users to a list
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-lists.subscribetolist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: unsubscribe-users-list
      description: Unsubscribe users from a list
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-lists.unsubscribefromlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.