openapi: 3.1.0
info:
  title: HubSpot Analytics Events Access Tokens Basic Operations API
  description: "The HubSpot Analytics Events API allows you to retrieve event completion data \nfrom your HubSpot account. Use this API to query event instances associated with \nCRM objects, filter by event types, and analyze user behavior and engagement patterns.\n\n## Key Features\n- Retrieve event instances for CRM objects\n- Filter events by type, date range, and object\n- Paginate through large result sets\n- Query available event types\n"
  version: 3.0.0
  contact:
    name: HubSpot Developer Support
    url: https://developers.hubspot.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://api.hubapi.com
  description: HubSpot Production API Server
tags:
- name: Basic Operations
  description: Create, read, update, and delete individual call records
paths:
  /crm/v3/objects/calls:
    get:
      tags:
      - Basic Operations
      summary: Hubspot List All Calls
      description: 'Returns a paginated list of all call engagements in the CRM.

        Use query parameters to filter by properties, limit results, and paginate through records.

        '
      operationId: listCalls
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "ListCallsSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/LimitParam'
        example: example-value
      - $ref: '#/components/parameters/AfterParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesWithHistoryParam'
        example: example-value
      - $ref: '#/components/parameters/AssociationsParam'
        example: example-value
      - $ref: '#/components/parameters/ArchivedParam'
        example: example-value
      responses:
        '200':
          description: Successfully retrieved the list of calls
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallCollectionResponse'
              examples:
                ListCallsSuccessResponse:
                  $ref: '#/components/examples/ListCallsSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.read
      - PrivateApp:
        - crm.objects.contacts.read
    post:
      tags:
      - Basic Operations
      summary: Hubspot Create a Call
      description: 'Creates a new call engagement in the CRM.

        You can specify call properties and optionally associate the call with other CRM objects.

        '
      operationId: createCall
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "CreateCallSuccessResponse"

          '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallCreateRequest'
            examples:
              CreateCallRequest:
                $ref: '#/components/examples/CreateCallRequest'
      responses:
        '201':
          description: Successfully created the call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Call'
              examples:
                CreateCallSuccessResponse:
                  $ref: '#/components/examples/CreateCallSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.write
      - PrivateApp:
        - crm.objects.contacts.write
  /crm/v3/objects/calls/{callId}:
    get:
      tags:
      - Basic Operations
      summary: Hubspot Get a Call by Id
      description: 'Retrieves a single call engagement by its unique identifier.

        Optionally include specific properties, property history, and associations.

        '
      operationId: getCallById
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "GetCallSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/CallIdParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesWithHistoryParam'
        example: example-value
      - $ref: '#/components/parameters/AssociationsParam'
        example: example-value
      - $ref: '#/components/parameters/ArchivedParam'
        example: example-value
      responses:
        '200':
          description: Successfully retrieved the call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Call'
              examples:
                GetCallSuccessResponse:
                  $ref: '#/components/examples/GetCallSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.read
      - PrivateApp:
        - crm.objects.contacts.read
    patch:
      tags:
      - Basic Operations
      summary: Hubspot Update a Call
      description: 'Updates an existing call engagement with new property values.

        Only the properties specified in the request body will be updated.

        '
      operationId: updateCall
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "UpdateCallSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/CallIdParam'
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallUpdateRequest'
            examples:
              UpdateCallRequest:
                $ref: '#/components/examples/UpdateCallRequest'
      responses:
        '200':
          description: Successfully updated the call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Call'
              examples:
                UpdateCallSuccessResponse:
                  $ref: '#/components/examples/UpdateCallSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.write
      - PrivateApp:
        - crm.objects.contacts.write
    delete:
      tags:
      - Basic Operations
      summary: Hubspot Archive a Call
      description: 'Archives (soft deletes) a call engagement by moving it to the recycling bin.

        Archived calls can be restored within 90 days.

        '
      operationId: archiveCall
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "ArchiveCallSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/CallIdParam'
        example: example-value
      responses:
        '204':
          description: Successfully archived the call (no content returned)
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.write
      - PrivateApp:
        - crm.objects.contacts.write
  /crm/v3/objects/notes:
    get:
      tags:
      - Basic Operations
      summary: Hubspot List All Notes
      description: 'Returns a paginated list of all note engagements in the CRM.

        Use query parameters to filter by properties, limit results, and paginate through records.

        '
      operationId: listNotes
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "ListNotesSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/LimitParam'
        example: example-value
      - $ref: '#/components/parameters/AfterParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesWithHistoryParam'
        example: example-value
      - $ref: '#/components/parameters/AssociationsParam'
        example: example-value
      - $ref: '#/components/parameters/ArchivedParam_2'
        example: example-value
      responses:
        '200':
          description: Successfully retrieved the list of notes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoteCollectionResponse'
              examples:
                ListNotesSuccessResponse:
                  $ref: '#/components/examples/ListNotesSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.read
      - PrivateApp:
        - crm.objects.contacts.read
    post:
      tags:
      - Basic Operations
      summary: Hubspot Create a Note
      description: 'Creates a new note engagement in the CRM.

        You can specify note properties and optionally associate the note with other CRM objects.

        '
      operationId: createNote
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "CreateNoteSuccessResponse"

          '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteCreateRequest'
            examples:
              CreateNoteRequest:
                $ref: '#/components/examples/CreateNoteRequest'
      responses:
        '201':
          description: Successfully created the note
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
              examples:
                CreateNoteSuccessResponse:
                  $ref: '#/components/examples/CreateNoteSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.write
      - PrivateApp:
        - crm.objects.contacts.write
  /crm/v3/objects/notes/{noteId}:
    get:
      tags:
      - Basic Operations
      summary: Hubspot Get a Note by Id
      description: 'Retrieves a single note engagement by its unique identifier.

        Optionally include specific properties, property history, and associations.

        '
      operationId: getNoteById
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "GetNoteSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/NoteIdParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesParam'
        example: example-value
      - $ref: '#/components/parameters/PropertiesWithHistoryParam'
        example: example-value
      - $ref: '#/components/parameters/AssociationsParam'
        example: example-value
      - $ref: '#/components/parameters/ArchivedParam_2'
        example: example-value
      responses:
        '200':
          description: Successfully retrieved the note
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
              examples:
                GetNoteSuccessResponse:
                  $ref: '#/components/examples/GetNoteSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.read
      - PrivateApp:
        - crm.objects.contacts.read
    patch:
      tags:
      - Basic Operations
      summary: Hubspot Update a Note
      description: 'Updates an existing note engagement with new property values.

        Only the properties specified in the request body will be updated.

        '
      operationId: updateNote
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "UpdateNoteSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/NoteIdParam'
        example: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteUpdateRequest'
            examples:
              UpdateNoteRequest:
                $ref: '#/components/examples/UpdateNoteRequest'
      responses:
        '200':
          description: Successfully updated the note
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
              examples:
                UpdateNoteSuccessResponse:
                  $ref: '#/components/examples/UpdateNoteSuccessResponse'
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.write
      - PrivateApp:
        - crm.objects.contacts.write
    delete:
      tags:
      - Basic Operations
      summary: Hubspot Archive a Note
      description: 'Archives (soft deletes) a note engagement by moving it to the recycling bin.

        Archived notes can be restored within 90 days.

        '
      operationId: archiveNote
      x-microcks-operation:
        dispatcher: SCRIPT
        dispatcherRules: 'return "ArchiveNoteSuccessResponse"

          '
      parameters:
      - $ref: '#/components/parameters/NoteIdParam'
        example: example-value
      responses:
        '204':
          description: Successfully archived the note (no content returned)
        default:
          description: An error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                ErrorResponse:
                  $ref: '#/components/examples/ErrorResponse'
      security:
      - OAuth2:
        - crm.objects.contacts.write
      - PrivateApp:
        - crm.objects.contacts.write
components:
  schemas:
    PropertyHistory:
      type: object
      description: Historical value of a property
      properties:
        value:
          type: string
          description: The historical value
          example: Discovery Call
        timestamp:
          type: string
          format: date-time
          description: When the value was set
          example: '2024-01-15T10:30:00.000Z'
        sourceType:
          type: string
          description: The source type that set this value
          example: CRM_UI
        sourceId:
          type: string
          description: The source identifier
          example: userId:12345
        sourceLabel:
          type: string
          description: Human-readable source label
          example: John Doe
        updatedByUserId:
          type: integer
          description: The user ID who made the change
          example: 12345
    CallCollectionResponse:
      type: object
      description: A paginated collection of calls
      required:
      - results
      properties:
        results:
          type: array
          description: The list of calls
          items:
            $ref: '#/components/schemas/Call'
          example:
          - id: '512'
            properties:
              hs_call_title: Discovery Call
              hs_call_body: Discussed product requirements
              hs_call_duration: '1800000'
              hs_call_direction: OUTBOUND
              hs_call_disposition: connected
              hs_call_status: COMPLETED
              hs_timestamp: '2024-01-15T10:30:00.000Z'
            propertiesWithHistory:
              key: value
            createdAt: '2024-01-15T10:30:00.000Z'
            updatedAt: '2024-01-15T11:00:00.000Z'
            archived: false
            archivedAt: '2025-03-15T14:30:00Z'
        paging:
          $ref: '#/components/schemas/Paging'
    AssociationInput_2:
      type: object
      description: Association to create with another object
      required:
      - to
      - types
      properties:
        to:
          type: object
          required:
          - id
          properties:
            id:
              type: string
              description: The ID of the object to associate with
              example: '101'
          example:
            id: '101'
        types:
          type: array
          description: The association types
          items:
            $ref: '#/components/schemas/AssociationType_2'
          example:
          - associationCategory: HUBSPOT_DEFINED
            associationTypeId: 202
    AssociationType_2:
      type: object
      description: Type of association
      required:
      - associationCategory
      - associationTypeId
      properties:
        associationCategory:
          type: string
          enum:
          - HUBSPOT_DEFINED
          - USER_DEFINED
          - INTEGRATOR_DEFINED
          description: The category of association
          example: HUBSPOT_DEFINED
        associationTypeId:
          type: integer
          description: The association type ID
          example: 202
    ErrorDetail:
      type: object
      description: Detailed error information
      required:
      - message
      properties:
        message:
          type: string
          description: Error message
          example: This is an example description.
        code:
          type: string
          description: Error code
          example: example-value
        in:
          type: string
          description: Field where error occurred
          example: example-value
        subCategory:
          type: string
          description: Error subcategory
          example: standard
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            key: value
    CallUpdateRequest:
      type: object
      description: Request body for updating a call
      required:
      - properties
      properties:
        properties:
          type: object
          description: The call properties to update
          additionalProperties:
            type: string
          example:
            hs_call_title: Updated Discovery Call
            hs_call_disposition: connected
    Note:
      type: object
      description: Represents a note engagement in the CRM
      required:
      - id
      - properties
      - createdAt
      - updatedAt
      - archived
      properties:
        id:
          type: string
          description: The unique identifier for the note
          example: '1024'
        properties:
          type: object
          description: The note properties
          additionalProperties:
            type: string
          example:
            hs_note_body: Met with client to discuss Q1 goals. They are interested in expanding their subscription.
            hs_timestamp: '2024-01-15T10:30:00.000Z'
            hubspot_owner_id: '12345'
        propertiesWithHistory:
          type: object
          description: Properties with their change history
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/PropertyHistory_2'
          example:
            key: value
        createdAt:
          type: string
          format: date-time
          description: When the note was created
          example: '2024-01-15T10:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the note was last updated
          example: '2024-01-15T11:00:00.000Z'
        archived:
          type: boolean
          description: Whether the note is archived
          example: false
        archivedAt:
          type: string
          format: date-time
          description: When the note was archived (if archived)
          example: '2025-03-15T14:30:00Z'
    Paging:
      type: object
      description: Pagination information
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
    AssociationInput:
      type: object
      description: Association to create with another object
      required:
      - to
      - types
      properties:
        to:
          type: object
          required:
          - id
          properties:
            id:
              type: string
              description: The ID of the object to associate with
              example: '101'
          example:
            id: '101'
        types:
          type: array
          description: The association types
          items:
            $ref: '#/components/schemas/AssociationType'
          example:
          - associationCategory: HUBSPOT_DEFINED
            associationTypeId: 194
    NoteCollectionResponse:
      type: object
      description: A paginated collection of notes
      required:
      - results
      properties:
        results:
          type: array
          description: The list of notes
          items:
            $ref: '#/components/schemas/Note'
          example:
          - id: '1024'
            properties:
              hs_note_body: Met with client to discuss Q1 goals. They are interested in expanding their subscription.
              hs_timestamp: '2024-01-15T10:30:00.000Z'
              hubspot_owner_id: '12345'
            propertiesWithHistory:
              key: value
            createdAt: '2024-01-15T10:30:00.000Z'
            updatedAt: '2024-01-15T11:00:00.000Z'
            archived: false
            archivedAt: '2025-03-15T14:30:00Z'
        paging:
          $ref: '#/components/schemas/Paging'
    NoteCreateRequest:
      type: object
      description: Request body for creating a note
      required:
      - properties
      properties:
        properties:
          type: object
          description: The note properties to set
          additionalProperties:
            type: string
          example:
            hs_note_body: Met with client to discuss Q1 goals. They are interested in expanding their subscription.
            hs_timestamp: '2024-01-15T10:30:00.000Z'
            hubspot_owner_id: '12345'
        associations:
          type: array
          description: Associations to create with other objects
          items:
            $ref: '#/components/schemas/AssociationInput_2'
          example:
          - to:
              id: {}
            types:
            - {}
    CallCreateRequest:
      type: object
      description: Request body for creating a call
      required:
      - properties
      properties:
        properties:
          type: object
          description: The call properties to set
          additionalProperties:
            type: string
          example:
            hs_call_title: Discovery Call
            hs_call_body: Discussed product requirements
            hs_call_duration: '1800000'
            hs_call_direction: OUTBOUND
            hs_timestamp: '2024-01-15T10:30:00.000Z'
        associations:
          type: array
          description: Associations to create with other objects
          items:
            $ref: '#/components/schemas/AssociationInput'
          example:
          - to:
              id: {}
            types:
            - {}
    NextPage:
      type: object
      description: Information about the next page
      required:
      - after
      properties:
        after:
          type: string
          description: Cursor for the next page
          example: NTI1Cg%3D%3D
        link:
          type: string
          description: Link to the next page
          example: https://app.hubspot.com/contacts/12345
    Error:
      type: object
      description: Error response
      required:
      - category
      - correlationId
      - message
      properties:
        category:
          type: string
          description: The error category
          example: VALIDATION_ERROR
        correlationId:
          type: string
          format: uuid
          description: Unique request identifier for debugging
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        message:
          type: string
          description: Human-readable error message
          example: Invalid input (details will vary based on the error)
        subCategory:
          type: string
          description: More specific error category
          example: standard
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            key: value
        links:
          type: object
          additionalProperties:
            type: string
          example:
            key: value
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
          example:
          - message: This is an example description.
            code: example-value
            in: example-value
            subCategory: standard
            context:
              key: value
    NoteUpdateRequest:
      type: object
      description: Request body for updating a note
      required:
      - properties
      properties:
        properties:
          type: object
          description: The note properties to update
          additionalProperties:
            type: string
          example:
            hs_note_body: Updated meeting notes - client confirmed interest in premium tier.
    Call:
      type: object
      description: Represents a call engagement in the CRM
      required:
      - id
      - properties
      - createdAt
      - updatedAt
      - archived
      properties:
        id:
          type: string
          description: The unique identifier for the call
          example: '512'
        properties:
          type: object
          description: The call properties
          additionalProperties:
            type: string
          example:
            hs_call_title: Discovery Call
            hs_call_body: Discussed product requirements
            hs_call_duration: '1800000'
            hs_call_direction: OUTBOUND
            hs_call_disposition: connected
            hs_call_status: COMPLETED
            hs_timestamp: '2024-01-15T10:30:00.000Z'
        propertiesWithHistory:
          type: object
          description: Properties with their change history
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/PropertyHistory'
          example:
            key: value
        createdAt:
          type: string
          format: date-time
          description: When the call was created
          example: '2024-01-15T10:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the call was last updated
          example: '2024-01-15T11:00:00.000Z'
        archived:
          type: boolean
          description: Whether the call is archived
          example: false
        archivedAt:
          type: string
          format: date-time
          description: When the call was archived (if archived)
          example: '2025-03-15T14:30:00Z'
    AssociationType:
      type: object
      description: Type of association
      required:
      - associationCategory
      - associationTypeId
      properties:
        associationCategory:
          type: string
          enum:
          - HUBSPOT_DEFINED
          - USER_DEFINED
          - INTEGRATOR_DEFINED
          description: The category of association
          example: HUBSPOT_DEFINED
        associationTypeId:
          type: integer
          description: The association type ID
          example: 194
    PropertyHistory_2:
      type: object
      description: Historical value of a property
      properties:
        value:
          type: string
          description: The historical value
          example: Initial meeting notes
        timestamp:
          type: string
          format: date-time
          description: When the value was set
          example: '2024-01-15T10:30:00.000Z'
        sourceType:
          type: string
          description: The source type that set this value
          example: CRM_UI
        sourceId:
          type: string
          description: The source identifier
          example: userId:12345
        sourceLabel:
          type: string
          description: Human-readable source label
          example: John Doe
        updatedByUserId:
          type: integer
          description: The user ID who made the change
          example: 12345
  examples:
    CreateCallSuccessResponse:
      summary: Successful response after creating a call
      value:
        id: '512'
        properties:
          hs_call_title: Discovery Call
          hs_call_body: Discussed product requirements
          hs_call_duration: '1800000'
          hs_call_direction: OUTBOUND
          hs_timestamp: '2024-01-15T10:30:00.000Z'
        createdAt: '2024-01-15T10:30:00.000Z'
        updatedAt: '2024-01-15T10:30:00.000Z'
        archived: false
    ListNotesSuccessResponse:
      summary: Successful response listing notes
      value:
        results:
        - id: '1024'
          properties:
            hs_note_body: Met with client to discuss Q1 goals. They are interested in expanding their subscription.
            hs_timestamp: '2024-01-15T10:30:00.000Z'
            hubspot_owner_id: '12345'
          createdAt: '2024-01-15T10:30:00.000Z'
          updatedAt: '2024-01-15T11:00:00.000Z'
          archived: false
        - id: '1025'
          properties:
            hs_note_body: Follow-up call scheduled for next week.
            hs_timestamp: '2024-01-16T14:00:00.000Z'
            hubspot_owner_id: '12345'
          createdAt: '2024-01-16T14:00:00.000Z'
          updatedAt: '2024-01-16T14:30:00.000Z'
          archived: false
        paging:
          next:
            after: MTAyNg%3D%3D
    GetCallSuccessResponse:
      summary: Successful response for a single call
      value:
        id: '512'
        properties:
          hs_call_title: Discovery Call
          hs_call_body: Discussed product requirements
          hs_call_duration: '1800000'
          hs_call_direction: OUTBOUND
          hs_call_disposition: connected
          hs_call_status: COMPLETED
          hs_timestamp: '2024-01-15T10:30:00.000Z'
        createdAt: '2024-01-15T10:30:00.000Z'
        updatedAt: '2024-01-15T11:00:00.000Z'
        archived: false
    ListCallsSuccessResponse:
      summary: Successful response listing calls
      value:
        results:
        - id: '512'
          properties:
            hs_call_title: Discovery Call
            hs_call_body: Discussed product requirements
            hs_call_duration: '1800000'
            hs_call_direction: OUTBOUND
            hs_call_disposition: connected
            hs_call_status: COMPLETED
            hs_timestamp: '2024-01-15T10:30:00.000Z'
          createdAt: '2024-01-15T10:30:00.000Z'
          updatedAt: '2024-01-15T11:00:00.000Z'
          archived: false
        - id: '513'
          properties:
            hs_call_title: Follow-up Call
            hs_call_body: Confirmed next steps
            hs_call_duration: '900000'
            hs_call_direction: OUTBOUND
            hs_call_disposition: connected
            hs_call_status: COMPLETED
            hs_timestamp: '2024-01-16T14:00:00.000Z'
          createdAt: '2024-01-16T14:00:00.000Z'
          updatedAt: '2024-01-16T14:30:00.000Z'
          archived: false
        paging:
          next:
            after: NTI1Cg%3D%3D
    UpdateNoteSuccessResponse:
      summary: Successful response after updating a note
      value:
        id: '1024'
        properties:
          hs_note_body: Updated meeting notes - client confirmed interest in premium tier.
          hs_timestamp: '2024-01-15T10:30:00.000Z'
          hubspot_owner_id: '12345'
        createdAt: '2024-01-15T10:30:00.000Z'
        updatedAt: '2024-01-15T12:00:00.000Z'
        archived: false
    CreateNoteRequest:
      summary: Request to create a note
      value:
        properties:
          hs_note_body: Met with client to discuss Q1 goals. They are interested in expanding their subscription.
          hs_timestamp: '2024-01-15T10:30:00.000Z'
          hubspot_owner_id: '12345'
        associations:
        - to:
            id: '101'
          types:
          - associationCategory: HUBSPOT_DEFINED
            associationTypeId: 202
    UpdateCallSuccessResponse:
      summary: Successful response after updating a call
      value:
        id: '512'
        properties:
          hs_call_title: Updated Discovery Call
          hs_call_body: Discussed product requirements
          hs_call_duration: '1800000'
          hs_call_direction: OUTBOUND
          hs_call_disposition: connected
          hs_timestamp: '2024-01-15T10:30:00.000Z'
        createdAt: '2024-01-15T10:30:00.000Z'
        updatedAt: '2024-01-15T12:00:00.000Z'
        archived: false
    GetNoteSuccessResponse:
      summary: Successful response for a single note
      value:
        id: '1024'
        properties:
          hs_note_body: Met with client to discuss Q1 goals. They are interested in expanding their subscription.
          hs_timestamp: '2024-01-15T10:30:00.000Z'
          hubspot_owner_id: '12345'
        createdAt: '2024-01-15T10:30:00.000Z'
        updatedAt: '2024-01-15T11:00:00.000Z'
        archived: false
    UpdateCallRequest:
      summary: Request to update a call
      value:
        properties:
          hs_call_title: Updated Discovery Call
          hs_call_disposition: connected
    CreateNoteSuccessResponse:
      summary: Successful response after creating a note
      value:
        id: '1024'
        properties:
          hs_note_body: Met with client to discuss Q1 goals. They are interested in expanding their subscription.
          hs_timestamp: '2024-01-15T10:30:00.000Z'
          hubspot_owner_id: '12345'
        createdAt: '2024-01-15T10:30:00.000Z'
        updatedAt: '2024-01-15T10:30:00.000Z'
        archived: false
    ErrorResponse:
      summary: Example error response
      value:
        category: VALIDATION_ERROR
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        message: Invalid input (details will vary based on the error)
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    UpdateNoteRequest:
      summary: Request to update a note
      value:
        properties:
          hs_note_body: Updated meeting notes - client confirmed interest in premium tier.
    CreateCallRequest:
      summary: Request to create a call
      value:
        properties:
          hs_call_title: Discovery Call
          hs_call_body: Discussed product requirements
          hs_call_duration: '1800000'
          hs_call_direction: OUTBOUND
          hs_timestamp: '2024-01-15T10:30:00.000Z'
        associations:
        - to:
            id: '101'
          types:
          - associationCategory: HUBSPOT_DEFINED
            associationTypeId: 194
  parameters:
    AfterParam:
      name: after
      in: query
      description: Pagination cursor from previous response
      required: false
      schema:
        type: string
    ArchivedParam:
      name: archived
      in: query
      description: Whether to include archived calls
      required: false
      schema:
        type: boolean
        default: false
    PropertiesWithHistoryParam:
      name: propertiesWithHistory
      in: query
      description: Comma-separated list of properties to return with history
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
    ArchivedParam_2:
      name: archived
      in: query
      description: Whether to include archived notes
      required: false
      schema:
        type: boolean
        default: false
    NoteIdParam:
      name: noteId
      in: path
      description: The unique identifier of the note
      required: true
      schema:
        type: string
      example: '1024'
    CallIdParam:
      name: callId
      in: path
      description: The unique identifier of the call
      required: true
      schema:
        type: string
      example: '512'
    AssociationsParam:
      name: associations
      in: query
      description: Comma-separated list of association types to retrieve
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
    LimitParam:
      name: limit
      in: query
      description: Maximum number of results per page
      required: false
      schema:
        type: integer
        default: 10
        maximum: 100
    PropertiesParam:
      name: properties
      in: query
      description: Comma-separated list of properties to return
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            analytics.read: Read analytics data