HubSpot CRM Engagement Notes API — Basic Operations

naftiko: 1.0.0-alpha2
info:
  label: HubSpot CRM Engagement Notes API — Basic Operations
  description: 'HubSpot CRM Engagement Notes API — Basic Operations. 5 operations. Lead operation: Hubspot List All Notes.
    Self-contained Naftiko capability covering one Hubspot business surface.'
  tags:
  - Hubspot
  - Basic Operations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUBSPOT_API_KEY: HUBSPOT_API_KEY
capability:
  consumes:
  - type: http
    namespace: engagement-notes-basic-operations
    baseUri: https://api.hubapi.com
    description: HubSpot CRM Engagement Notes API — Basic Operations business capability. Self-contained, no shared references.
    resources:
    - name: crm-v3-objects-notes
      path: /crm/v3/objects/notes
      operations:
      - name: listnotes
        method: GET
        description: Hubspot List All Notes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createnote
        method: POST
        description: Hubspot Create a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: crm-v3-objects-notes-noteId
      path: /crm/v3/objects/notes/{noteId}
      operations:
      - name: getnotebyid
        method: GET
        description: Hubspot Get a Note by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatenote
        method: PATCH
        description: Hubspot Update a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: archivenote
        method: DELETE
        description: Hubspot Archive a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.HUBSPOT_API_KEY}}'
  exposes:
  - type: rest
    namespace: engagement-notes-basic-operations-rest
    port: 8080
    description: REST adapter for HubSpot CRM Engagement Notes API — Basic Operations. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/crm/v3/objects/notes
      name: crm-v3-objects-notes
      description: REST surface for crm-v3-objects-notes.
      operations:
      - method: GET
        name: listnotes
        description: Hubspot List All Notes
        call: engagement-notes-basic-operations.listnotes
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createnote
        description: Hubspot Create a Note
        call: engagement-notes-basic-operations.createnote
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/notes/{noteid}
      name: crm-v3-objects-notes-noteid
      description: REST surface for crm-v3-objects-notes-noteId.
      operations:
      - method: GET
        name: getnotebyid
        description: Hubspot Get a Note by Id
        call: engagement-notes-basic-operations.getnotebyid
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatenote
        description: Hubspot Update a Note
        call: engagement-notes-basic-operations.updatenote
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: archivenote
        description: Hubspot Archive a Note
        call: engagement-notes-basic-operations.archivenote
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: engagement-notes-basic-operations-mcp
    port: 9090
    transport: http
    description: MCP adapter for HubSpot CRM Engagement Notes API — Basic Operations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: hubspot-list-all-notes
      description: Hubspot List All Notes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: engagement-notes-basic-operations.listnotes
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-create-note
      description: Hubspot Create a Note
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: engagement-notes-basic-operations.createnote
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-get-note-id
      description: Hubspot Get a Note by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: engagement-notes-basic-operations.getnotebyid
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-update-note
      description: Hubspot Update a Note
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: engagement-notes-basic-operations.updatenote
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-archive-note
      description: Hubspot Archive a Note
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: engagement-notes-basic-operations.archivenote
      outputParameters:
      - type: object
        mapping: $.