---
updatedAt: 2026-05-12T09:59:38.000Z
---

# Retrieve event subscriptions

This operation returns an object containing information about event groups and the associated subscription information for the current user.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "EventSubscriptionInfo": {
        "description": "EventSubscriptionInfo contains the data structure returned for user subscription information",
        "properties": {
          "description": {
            "type": "string"
          },
          "subscribed": {
            "type": "boolean"
          },
          "value": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "UserSubscriptionGroups": {
        "description": "UserSubscriptionGroups contains the data structure for an event grouping",
        "properties": {
          "allEventsSubscribed": {
            "type": "boolean"
          },
          "subscriptionGroupEvents": {
            "items": {
              "$ref": "#/components/schemas/EventSubscriptionInfo"
            },
            "type": "array"
          },
          "subscriptionGroupType": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "eventSubscriptionGroupsSwagger": {
        "properties": {
          "collection": {
            "items": {
              "$ref": "#/components/schemas/UserSubscriptionGroups"
            },
            "type": "array"
          },
          "page": {
            "$ref": "#/components/schemas/eventSubscriptionsPageData"
          }
        },
        "type": "object"
      },
      "eventSubscriptionsPageData": {
        "description": "a unique schema ID for swagger page data",
        "properties": {
          "totalCount": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "title": "Event Subscriptions API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/eventSubscriptions": {
      "get": {
        "description": "This operation returns an object containing information about event groups and the associated subscription information for the current user.",
        "operationId": "getEventSubscriptions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/eventSubscriptionGroupsSwagger"
                }
              }
            },
            "description": "EventSubscriptionTypesResponse provides a list of event subscription types"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            },
            "description": "BadRequestResponse indicates a request with invalid parameters"
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access"
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
          },
          "500": {
            "description": "GenericError generic error"
          }
        },
        "summary": "Retrieve event subscriptions",
        "tags": [
          "Event Subscriptions API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Event Subscriptions API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```