API Reference — subpackage_automations

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_automations
  description: 'API Reference — subpackage_automations. 3 operations. Lead operation: List automations <Badge intent="info"
    minimal outlined>OAuth Scope: automations:read</Badge>. Self-contained Naftiko capability covering one Beehiiv business
    surface.'
  tags:
  - Beehiiv
  - subpackage_automations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BEEHIIV_API_KEY: BEEHIIV_API_KEY
capability:
  consumes:
  - type: http
    namespace: beehiiv-subpackage-automations
    baseUri: https://api.beehiiv.com/v2
    description: API Reference — subpackage_automations business capability. Self-contained, no shared references.
    resources:
    - name: publications-publicationId-automations
      path: /publications/{publicationId}/automations
      operations:
      - name: index
        method: GET
        description: 'List automations <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: expand[]
          in: query
          type: string
          description: Optional list of expandable objects.
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default
            is 10.
        - name: page
          in: query
          type: integer
          description: 'Pagination returns the results in pages. Each page contains the number of results specified by the
            `limit` (default: 10).<br>If not specified, results 1-10 from'
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    - name: publications-publicationId-automations-automationId
      path: /publications/{publicationId}/automations/{automationId}
      operations:
      - name: show
        method: GET
        description: 'Get automation <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: automationId
          in: path
          type: string
          description: The prefixed ID of the automation object
          required: true
        - name: expand[]
          in: query
          type: string
          description: Optional list of expandable objects.
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    - name: publications-publicationId-automations-automationId-emails
      path: /publications/{publicationId}/automations/{automationId}/emails
      operations:
      - name: listemails
        method: GET
        description: List automation emails
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: publicationId
          in: path
          type: string
          description: The prefixed ID of the publication object
          required: true
        - name: automationId
          in: path
          type: string
          description: The prefixed ID of the automation object
          required: true
        - name: limit
          in: query
          type: integer
          description: A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default
            is 10.
        - name: cursor
          in: query
          type: string
          description: '**Cursor-based pagination (recommended)**: Use this opaque cursor token to fetch the next page of
            results. Obtain it from the `next_cursor` field of a previous '
        - name: page
          in: query
          type: integer
          description: '**Deprecated**: Use `cursor` instead. Pagination returns the results in pages. Limited to 100 pages
            maximum.'
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
    authentication:
      type: bearer
      token: '{{env.BEEHIIV_API_KEY}}'
  exposes:
  - type: rest
    namespace: beehiiv-subpackage-automations-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_automations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/publications/{publicationid}/automations
      name: publications-publicationid-automations
      description: REST surface for publications-publicationId-automations.
      operations:
      - method: GET
        name: index
        description: 'List automations <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        call: beehiiv-subpackage-automations.index
        with:
          publicationId: rest.publicationId
          expand[]: rest.expand[]
          limit: rest.limit
          page: rest.page
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/publications/{publicationid}/automations/{automationid}
      name: publications-publicationid-automations-automationid
      description: REST surface for publications-publicationId-automations-automationId.
      operations:
      - method: GET
        name: show
        description: 'Get automation <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
        call: beehiiv-subpackage-automations.show
        with:
          publicationId: rest.publicationId
          automationId: rest.automationId
          expand[]: rest.expand[]
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/publications/{publicationid}/automations/{automationid}/emails
      name: publications-publicationid-automations-automationid-emails
      description: REST surface for publications-publicationId-automations-automationId-emails.
      operations:
      - method: GET
        name: listemails
        description: List automation emails
        call: beehiiv-subpackage-automations.listemails
        with:
          publicationId: rest.publicationId
          automationId: rest.automationId
          limit: rest.limit
          cursor: rest.cursor
          page: rest.page
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: beehiiv-subpackage-automations-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_automations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-automations-badge-intent-info-minimal
      description: 'List automations <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-automations.index
      with:
        publicationId: tools.publicationId
        expand[]: tools.expand[]
        limit: tools.limit
        page: tools.page
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-automation-badge-intent-info-minimal
      description: 'Get automation <Badge intent="info" minimal outlined>OAuth Scope: automations:read</Badge>'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-automations.show
      with:
        publicationId: tools.publicationId
        automationId: tools.automationId
        expand[]: tools.expand[]
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: list-automation-emails
      description: List automation emails
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: beehiiv-subpackage-automations.listemails
      with:
        publicationId: tools.publicationId
        automationId: tools.automationId
        limit: tools.limit
        cursor: tools.cursor
        page: tools.page
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.