HubSpot Basic API

openapi: 3.2.0
info:
  title: Hubspot Basic API
  x-refined-note:
  - x-hubspot-api-use-case differs across the merged source definitions and was not carried
  - x-hubspot-introduction differs across the merged source definitions and was not carried
  - x-hubspot-product-tier-requirements differs across the merged source definitions and was not carried
  - x-hubspot-related-documentation differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Basic across 93 of this provider''s published API definitions: hubspot-account-account-info-openapi.json, hubspot-automation-email-templates-openapi.json, hubspot-automation-sequences-openapi.json, hubspot-business-units-business-units-openapi.json, hubspot-cms-authors-openapi.json, hubspot-cms-blog-settings-openapi.json, hubspot-cms-cms-content-audit-openapi.json, hubspot-cms-domains-openapi.json, hubspot-cms-media-bridge-openapi.json, hubspot-cms-pages-openapi.json…'
servers:
- url: https://api.hubapi.com
- url: https://private.hubapi.com
tags:
- name: Basic
paths:
  /account-info/2026-09/activity/audit-logs:
    get:
      tags:
      - Basic
      summary: Retrieve audit logs
      description: Retrieve audit logs for user actions within the account. This endpoint allows you to filter logs based on various criteria such as time range, user ID, and sorting preferences. It is useful for monitoring and reviewing user activities for security and compliance purposes.
      operationId: get-/account-info/2026-09/activity/audit-logs
      parameters:
      - name: actingUserId
        in: query
        description: An array of user IDs to filter the audit logs by the acting user.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: after
        in: query
        description: A cursor token for pagination. Use the value from the previous response's paging.next.after field to retrieve the next set of results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: fillFinalTimestamp
        in: query
        description: A boolean indicating whether to fill the final timestamp in the response.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: occurredAfter
        in: query
        description: Filter logs to include only those that occurred after this date-time.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: occurredBefore
        in: query
        description: Filter logs to include only those that occurred before this date-time.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: sort
        in: query
        description: An array specifying the sort order of the results.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePublicApiUserActionEventForwardPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - account-info.security.read
    servers:
    - url: https://api.hubapi.com
  /account-info/2026-09/activity/login:
    get:
      tags:
      - Basic
      summary: Retrieve Logins
      description: Retrieve login activity for users in your HubSpot account. This endpoint provides access to login audit logs, allowing you to track user login events. It supports pagination and filtering by user ID.
      operationId: get-/account-info/2026-09/activity/login
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource, returned as the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: userId
        in: query
        description: The unique identifier of the user whose login activity is being retrieved.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePublicLoginAuditForwardPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - account-info.security.read
    servers:
    - url: https://api.hubapi.com
  /account-info/2026-09/activity/security:
    get:
      tags:
      - Basic
      summary: Retrieve security activity
      description: Retrieve critical security-related activities for your account. This endpoint allows you to filter activities by user and time range, helping you monitor and audit important security events.
      operationId: get-/account-info/2026-09/activity/security
      parameters:
      - name: after
        in: query
        description: The paging cursor token for retrieving the next set of results. Use the value from the previous response's paging.next.after field.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: fromTimestamp
        in: query
        description: The start of the time range for the activities to be retrieved, specified as a Unix timestamp.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: limit
        in: query
        description: The maximum number of results to return per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: toTimestamp
        in: query
        description: The end of the time range for the activities to be retrieved, specified as a Unix timestamp.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: userId
        in: query
        description: The unique identifier of the user whose activities you want to retrieve.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseHydratedCriticalActionForwardPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - account-info.security.read
    servers:
    - url: https://api.hubapi.com
  /account-info/2026-09/api-usage/daily/private-apps:
    get:
      tags:
      - Basic
      summary: Retrieve API Usage
      description: Retrieve the daily API usage for private apps in the account. This endpoint provides insights into the API consumption patterns, helping users monitor and manage their API usage effectively.
      operationId: get-/account-info/2026-09/api-usage/daily/private-apps
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseApiUsageNoPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - external-settings-access
    servers:
    - url: https://api.hubapi.com
  /account-info/2026-09/details:
    get:
      tags:
      - Basic
      summary: Retrieve details
      description: Retrieve detailed information about the account associated with the HubSpot portal. This endpoint provides insights into the account type, time zone, currency settings, and data hosting location. It is useful for obtaining a comprehensive overview of the account's configuration and settings.
      operationId: get-/account-info/2026-09/details
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortalInformationResponseSeptember2026'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - external-settings-access
      x-hubspot-user-level-auth:
        internalOnly: false
    servers:
    - url: https://api.hubapi.com
  /automation/email-templates/2026-09:
    get:
      tags:
      - Basic
      summary: List templates
      description: 'Retrieve a list of email templates available in the HubSpot account. This endpoint supports pagination to navigate through large sets of templates. Use this endpoint to access and manage your email templates efficiently. Please note: the scopes for these endpoints require user-level access and will not work for existing apps with portal-level access.'
      operationId: get-/automation/email-templates/2026-09_/automation/email-templates/2026-09-beta
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource, returned as the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to display per page. Defaults to 20.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePublicTemplateForwardPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - sales-templates-public-read
      x-hubspot-user-level-auth:
        internalOnly: false
    post:
      tags:
      - Basic
      summary: Create
      description: 'Create a new email template in your HubSpot account. This endpoint allows you to define the template''s name, subject, body, and optionally assign it to a folder. The request must include the template''s body and name. Please note: the scopes for these endpoints require user-level access and will not work for existing apps with portal-level access.'
      operationId: post-/automation/email-templates/2026-09_/automation/email-templates/2026-09-beta
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicTemplateInput'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTemplate'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - sales-templates-public-write
      x-hubspot-user-level-auth:
        internalOnly: false
    servers:
    - url: https://api.hubapi.com
  /automation/email-templates/2026-09/folders:
    get:
      tags:
      - Basic
      summary: List folders
      description: 'Retrieve a list of email template folders available in your HubSpot account. This endpoint supports pagination to navigate through large sets of folders. Use this endpoint to organize and manage your email templates efficiently. Please note: the scopes for these endpoints require user-level access and will not work for existing apps with portal-level access.'
      operationId: get-/automation/email-templates/2026-09/folders_/automation/email-templates/2026-09-beta/folders
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource. Use this token to retrieve the next set of results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of results to display per page. Defaults to 20.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePublicFolderForwardPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - sales-templates-public-read
      x-hubspot-user-level-auth:
        internalOnly: false
    servers:
    - url: https://api.hubapi.com
  /automation/email-templates/2026-09/{templateId}:
    get:
      tags:
      - Basic
      summary: Retrieve template
      description: 'Retrieve a specific email template by its unique identifier. This endpoint allows you to access the details of an email template, which can be useful for reviewing or managing your email automation strategies. Please note: the scopes for these endpoints require user-level access and will not work for existing apps with portal-level access.'
      operationId: get-/automation/email-templates/2026-09/{templateId}_/automation/email-templates/2026-09-beta/{templateId}
      parameters:
      - name: templateId
        in: path
        description: The unique identifier of the email template to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTemplate'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - sales-templates-public-read
      x-hubspot-user-level-auth:
        internalOnly: false
    patch:
      tags:
      - Basic
      summary: Update template
      description: 'Update an existing email template in your HubSpot account. This endpoint allows you to modify the template''s properties such as name, subject, body, and folderId. Ensure that the templateId provided corresponds to an existing template. Please note: the scopes for these endpoints require user-level access and will not work for existing apps with portal-level access.'
      operationId: patch-/automation/email-templates/2026-09/{templateId}_/automation/email-templates/2026-09-beta/{templateId}
      parameters:
      - name: templateId
        in: path
        description: The unique identifier of the email template to update.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicTemplateUpdate'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicTemplate'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - sales-templates-public-write
      x-hubspot-user-level-auth:
        internalOnly: false
    servers:
    - url: https://api.hubapi.com
  /automation/sequences/2026-03:
    get:
      tags:
      - Basic
      operationId: get-/automation/sequences/2026-03_/automation/sequences/2026-03
      parameters:
      - name: userId
        in: query
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: after
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseWithTotalPublicSequenceLiteResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - automation.sequences.read
      summary: Get /automation/sequences/2026 03 /automation/sequences/2026 03
      x-summary-source: derived
    servers:
    - url: https://api.hubapi.com
  /automation/sequences/2026-03/enrollments:
    post:
      tags:
      - Basic
      summary: Enroll a contact in a sequence
      description: Enroll a contact into a sequence using the specified user ID and sequence details.
      operationId: post-/automation/sequences/2026-03/enrollments
      parameters:
      - name: userId
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicSequenceEnrollmentRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSequenceEnrollmentLiteResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - automation.sequences.enrollments.write
    servers:
    - url: https://api.hubapi.com
  /automation/sequences/2026-03/enrollments/contact/{contactId}:
    get:
      tags:
      - Basic
      summary: Retrieve the enrollment status of a contact
      description: Get the enrollment status of a contact in sequences by their contact ID.
      operationId: get-/automation/sequences/2026-03/enrollments/contact/{contactId}
      parameters:
      - name: contactId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSequenceEnrollmentResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - automation.sequences.read
    servers:
    - url: https://api.hubapi.com
  /automation/sequences/2026-03/{sequenceId}:
    get:
      tags:
      - Basic
      summary: Retrieve details for a sequence
      description: Retrieve details of a specific sequence by its ID.
      operationId: get-/automation/sequences/2026-03/{sequenceId}
      parameters:
      - name: sequenceId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: userId
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicSequenceResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - automation.sequences.read
    servers:
    - url: https://api.hubapi.com
  /business-units/public/2026-09/business-units/user/{userId}:
    get:
      tags:
      - Basic
      summary: Retrieve brands by associated user
      description: Retrieve the brands that a specific user can access.
      operationId: get-/business-units/public/2026-09/business-units/user/{userId}_getByUserID
      parameters:
      - name: userId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: name
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: properties
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponsePublicBusinessUnitNoPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - business_units_view.read
    servers:
    - url: https://api.hubapi.com
  /cms/blogs/2026-09/authors:
    get:
      tags:
      - Basic
      summary: Get all Blog Authors
      description: Get the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
      operationId: get-/cms/blogs/2026-09/authors_getPage
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: createdAfter
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: property
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: updatedAfter
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedBefore
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CollectionResponseWithTotalBlogAuthorForwardPaging'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - content
    post:
      tags:
      - Basic
      summary: Create a new Blog Author
      description: Create a new Blog Author.
      operationId: post-/cms/blogs/2026-09/authors_create
      parameters: []
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BlogAuthor'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BlogAuthor'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - content
    servers:
    - url: https://api.hubapi.com
  /cms/blogs/2026-09/authors/{objectId}:
    get:
      tags:
      - Basic
      summary: Retrieve a Blog Author
      description: Retrieve the Blog Author object identified by the id in the path.
      operationId: get-/cms/blogs/2026-09/authors/{objectId}_getById
      parameters:
      - name: objectId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: property
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BlogAuthor'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - content
    delete:
      tags:
      - Basic
      summary: Delete a Blog Author
      description: Delete the Blog Author object identified by the id in the path.
      operationId: delete-/cms/blogs/2026-09/authors/{objectId}_archive
      parameters:
      - name: objectId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '204':
          description: No content
          content: {}
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - content
    patch:
      tags:
      - Basic
      summary: Update a Blog Author
      description: 'Sparse updates a single Blog Author object identified by the id in the path.

        All the column values need not be specified. Only the that need to be modified can be specified.'
      operationId: patch-/cms/blogs/2026-09/authors/{objectId}_update
      parameters:
      - name: objectId
        in: path
        description: ''
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BlogAuthor'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BlogAuthor'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - content
    servers:
    - url: https://api.hubapi.com
  /cms/blog-settings/2026-09/settings:
    get:
      tags:
      - Basic
      summary: Retrieve all blogs
      description: Get the list of blogs. Results can be limited and filtered by creation or updated date.
      operationId: get-/cms/blog-settings/2026-09/settings
      parameters:
      - name: after
        in: query
        description: The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: archived
        in: query
        description: Whether to return only results that have been archived.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: createdAfter
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: The maximum number of results to display per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: updatedAfter
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedAt
        in: query
        description: ''
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: updatedBef

# --- truncated at 32 KB (3001 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/openapi/hubspot-basic-api-openapi.yml