HubSpot CRM Deals API — Deals

naftiko: 1.0.0-alpha2
info:
  label: HubSpot CRM Deals API — Deals
  description: 'HubSpot CRM Deals API — Deals. 6 operations. Lead operation: Hubspot List Deals. Self-contained Naftiko capability
    covering one Hubspot business surface.'
  tags:
  - Hubspot
  - Deals
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUBSPOT_API_KEY: HUBSPOT_API_KEY
capability:
  consumes:
  - type: http
    namespace: crm-deals-deals
    baseUri: https://api.hubapi.com
    description: HubSpot CRM Deals API — Deals business capability. Self-contained, no shared references.
    resources:
    - name: crm-v3-objects-deals
      path: /crm/v3/objects/deals
      operations:
      - name: listdeals
        method: GET
        description: Hubspot List Deals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to return per page.
        - name: after
          in: query
          type: string
          description: The cursor for pagination to get the next page of results.
        - name: properties
          in: query
          type: string
          description: A comma-separated list of property names to return.
        - name: archived
          in: query
          type: boolean
          description: Whether to return archived deals.
      - name: createdeal
        method: POST
        description: Hubspot Create a Deal
        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-deals-search
      path: /crm/v3/objects/deals/search
      operations:
      - name: searchdeals
        method: POST
        description: Hubspot Search Deals
        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-deals-dealId
      path: /crm/v3/objects/deals/{dealId}
      operations:
      - name: getdeal
        method: GET
        description: Hubspot Get a Deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dealId
          in: path
          type: string
          description: The ID of the deal to retrieve.
          required: true
        - name: properties
          in: query
          type: string
          description: A comma-separated list of property names to return.
        - name: archived
          in: query
          type: boolean
          description: Whether to return archived deals.
      - name: updatedeal
        method: PATCH
        description: Hubspot Update a Deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dealId
          in: path
          type: string
          description: The ID of the deal to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletedeal
        method: DELETE
        description: Hubspot Archive a Deal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dealId
          in: path
          type: string
          description: The ID of the deal to archive.
          required: true
    authentication:
      type: bearer
      token: '{{env.HUBSPOT_API_KEY}}'
  exposes:
  - type: rest
    namespace: crm-deals-deals-rest
    port: 8080
    description: REST adapter for HubSpot CRM Deals API — Deals. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/crm/v3/objects/deals
      name: crm-v3-objects-deals
      description: REST surface for crm-v3-objects-deals.
      operations:
      - method: GET
        name: listdeals
        description: Hubspot List Deals
        call: crm-deals-deals.listdeals
        with:
          limit: rest.limit
          after: rest.after
          properties: rest.properties
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdeal
        description: Hubspot Create a Deal
        call: crm-deals-deals.createdeal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/deals/search
      name: crm-v3-objects-deals-search
      description: REST surface for crm-v3-objects-deals-search.
      operations:
      - method: POST
        name: searchdeals
        description: Hubspot Search Deals
        call: crm-deals-deals.searchdeals
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/crm/v3/objects/deals/{dealid}
      name: crm-v3-objects-deals-dealid
      description: REST surface for crm-v3-objects-deals-dealId.
      operations:
      - method: GET
        name: getdeal
        description: Hubspot Get a Deal
        call: crm-deals-deals.getdeal
        with:
          dealId: rest.dealId
          properties: rest.properties
          archived: rest.archived
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatedeal
        description: Hubspot Update a Deal
        call: crm-deals-deals.updatedeal
        with:
          dealId: rest.dealId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedeal
        description: Hubspot Archive a Deal
        call: crm-deals-deals.deletedeal
        with:
          dealId: rest.dealId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: crm-deals-deals-mcp
    port: 9090
    transport: http
    description: MCP adapter for HubSpot CRM Deals API — Deals. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: hubspot-list-deals
      description: Hubspot List Deals
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: crm-deals-deals.listdeals
      with:
        limit: tools.limit
        after: tools.after
        properties: tools.properties
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-create-deal
      description: Hubspot Create a Deal
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: crm-deals-deals.createdeal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-search-deals
      description: Hubspot Search Deals
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: crm-deals-deals.searchdeals
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-get-deal
      description: Hubspot Get a Deal
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: crm-deals-deals.getdeal
      with:
        dealId: tools.dealId
        properties: tools.properties
        archived: tools.archived
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-update-deal
      description: Hubspot Update a Deal
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: crm-deals-deals.updatedeal
      with:
        dealId: tools.dealId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: hubspot-archive-deal
      description: Hubspot Archive a Deal
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: crm-deals-deals.deletedeal
      with:
        dealId: tools.dealId
      outputParameters:
      - type: object
        mapping: $.