;
};
## OpenAPI
````yaml specs/2026-03/webhooks-webhooks-v2026-03.json GET /webhooks-journal/subscriptions/2026-03
openapi: 3.0.1
info:
title: Webhooks Webhooks
description: Basepom for all HubSpot Projects
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
- name: Batch
paths:
/webhooks-journal/subscriptions/2026-03:
get:
tags:
- Basic
summary: Get Existing Subscriptions
description: Fetch existing subscriptions for the authenticated app
operationId: >-
get-/webhooks-journal/subscriptions/2026-03_/webhooks-journal/subscriptions/2026-03
parameters: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: >-
#/components/schemas/CollectionResponseSubscriptionResponseNoPaging
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- webhooks-journal-subscription-read
components:
schemas:
CollectionResponseSubscriptionResponseNoPaging:
required:
- results
type: object
properties:
results:
type: array
description: >-
An array of SubscriptionResponse objects, each representing a
subscription's details such as actions, appId, createdAt, and other
relevant properties.
items:
$ref: '#/components/schemas/SubscriptionResponse_1'
SubscriptionResponse_1:
required:
- actions
- appId
- createdAt
- id
- objectTypeId
- subscriptionType
- updatedAt
type: object
properties:
actionOverrides:
type: object
additionalProperties:
$ref: '#/components/schemas/ActionOverrideRequest'
description: >-
An object containing action overrides, where each key is an action
and the value is an ActionOverrideRequest object.
actions:
type: array
description: >-
A list of actions that trigger the subscription. Possible values
include 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE',
'ASSOCIATION_ADDED', 'ASSOCIATION_REMOVED', 'SNAPSHOT',
'APP_INSTALL', 'APP_UNINSTALL', 'ADDED_TO_LIST',
'REMOVED_FROM_LIST', and 'GDPR_DELETE'.
items:
type: string
enum:
- CREATE
- UPDATE
- DELETE
- MERGE
- RESTORE
- ASSOCIATION_ADDED
- ASSOCIATION_REMOVED
- SNAPSHOT
- APP_INSTALL
- APP_UNINSTALL
- ADDED_TO_LIST
- REMOVED_FROM_LIST
- GDPR_DELETE
appId:
type: integer
description: >-
The unique identifier for the app associated with the subscription.
It is an integer formatted as int64.
format: int64
associatedObjectTypeIds:
type: array
description: A list of associated object type IDs. Each ID is a string.
items:
type: string
createdAt:
type: string
description: >-
The date and time when the subscription was created, in ISO 8601
format.
format: date-time
createdBy:
type: integer
description: >-
The ID of the user who created the subscription. It is an integer
formatted as int64.
format: int64
deletedAt:
type: string
description: >-
The date and time when the subscription was deleted, in ISO 8601
format, if applicable.
format: date-time
id:
type: integer
description: >-
The unique identifier for the subscription. It is an integer
formatted as int64.
format: int64
listIds:
type: array
description: >-
A list of list IDs associated with the subscription. Each ID is an
integer formatted as int64.
items:
type: integer
format: int64
objectIds:
type: array
description: >-
A list of object IDs associated with the subscription. Each ID is an
integer formatted as int64.
items:
type: integer
format: int64
objectTypeId:
type: string
description: >-
The identifier for the object type associated with the subscription.
It is a string.
portalId:
type: integer
description: >-
The unique identifier for the portal associated with the
subscription. It is an integer formatted as int64.
format: int64
properties:
type: array
description: >-
A list of property names associated with the subscription. Each
property is a string.
items:
type: string
subscriptionType:
type: string
description: >-
The type of subscription, which can be one of the following:
'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT',
'LIST_MEMBERSHIP', or 'GDPR_PRIVACY_DELETION'.
enum:
- APP_LIFECYCLE_EVENT
- ASSOCIATION
- EVENT
- GDPR_PRIVACY_DELETION
- LIST_MEMBERSHIP
- OBJECT
updatedAt:
type: string
description: >-
The date and time when the subscription was last updated, in ISO
8601 format.
format: date-time
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
ActionOverrideRequest:
type: object
properties:
associatedObjectTypeIds:
type: array
description: >-
An array of strings, each representing an associated object type ID
relevant to the action override.
items:
type: string
listIds:
type: array
description: >-
An array of integers representing list IDs that are associated with
the action override. The integers are in int64 format.
items:
type: integer
format: int64
objectIds:
type: array
description: >-
An array of integers, each representing an object ID for which the
action override is applicable. The integers are in int64 format.
items:
type: integer
format: int64
properties:
type: array
description: >-
An array of strings representing the properties to be overridden in
the action. Each string corresponds to a property name.
items:
type: string
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
developers-read: ''
developers-write: ''
private-apps-read: ''
private-apps-write: ''
webhooks-journal-data-access: ''
webhooks-journal-snapshot-management: ''
webhooks-journal-subscription-management: ''
webhooks-journal-subscription-read: ''
````
{product.name} -
{product.level}
)}