> ## Documentation Index > Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # List Notification Groups > Retrieves a list of all notification groups configured for the authenticated user's workspace. Each group represents a specific set of rules for routing alerts. ## OpenAPI ````yaml /api/en/notifications.yaml get /notifications openapi: 3.0.3 info: title: Altostrat Notifications API version: 1.0.0 description: >- The Altostrat Notifications API is the microservice responsible for creating, configuring, and managing alert routing and delivery channels. It acts as the central hub for all platform-generated alerts, ensuring that critical events from SD-WAN, network automation, and AI agents are delivered to the right people through the right channels at the right time. This API allows you to programmatically manage: - **Notification Groups:** The core resource that links specific alert topics, target sites, and recipients to a notification schedule and delivery channel. - **Topics:** Pre-defined categories of alerts (e.g., 'WAN Failover', 'Heartbeat', 'SLA Reports') that users can subscribe to. Developers use this API to build sophisticated, context-aware notification rules, ensuring that network operators and stakeholders are immediately informed of events that require their attention. servers: - url: https://v1.api.altostrat.io security: - OAuth2: [] tags: - name: Notification Groups description: Manage the core notification routing rules. - name: Topics description: Retrieve available alert categories. paths: /notifications: get: tags: - Notification Groups summary: List Notification Groups description: >- Retrieves a list of all notification groups configured for the authenticated user's workspace. Each group represents a specific set of rules for routing alerts. operationId: listNotificationGroups responses: '200': description: A list of notification groups. content: application/json: schema: type: array items: $ref: '#/components/schemas/NotificationGroup' '403': description: Forbidden - The user does not have the required permissions. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal Server Error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - OAuth2: - notification:view components: schemas: NotificationGroup: type: object properties: id: type: string format: uuid description: The unique identifier for the notification group. example: ntfgrp_9b01a14c-1123-4279-88b1-3e42f9b846e1 name: type: string description: A human-readable name for the notification group. example: Primary On-Call Team Alerts schedule_id: type: string format: uuid description: >- The UUID of a Schedule object from the Chrono API, which defines when this group is active. example: sch_7d1b8c0c-5121-4f27-849c-29b3a0e6201a mute: type: string description: >- Controls the mute state of the group. `schedule-active` mutes when the schedule is inactive, `schedule-inactive` mutes when the schedule is active. `never` and `always` are absolute states. enum: - schedule-active - schedule-inactive - never - always example: schedule-active notifiables: type: array description: An array of recipients and their designated notification channels. items: $ref: '#/components/schemas/NotifiableRecipient' topics: type: array description: An array of Topic UUIDs to which this group subscribes. items: type: string format: uuid example: - top_9cffb446-18a5-445a-948c-e6f1d98930af - top_9ba5d51f-3ada-44f2-9fb9-bf2404a29f50 sites: type: array description: >- An array of Site UUIDs that this group will receive notifications for. items: type: string format: uuid example: - site_a2b3c4d5-e6f7-g8h9-i0j1-k2l3m4n5o6p7 - site_b3c4d5e6-f7g8-h9i0-j1k2-l3m4n5o6p7q8 created_at: type: string format: date-time description: The timestamp when the notification group was created. example: '2025-10-29T12:24:17.000Z' updated_at: type: string format: date-time description: The timestamp when the notification group was last updated. example: '2025-10-29T12:28:00.000Z' ErrorResponse: type: object properties: type: type: string description: A broad category for the error (e.g., 'invalid_request_error'). example: invalid_request_error code: type: string description: A short, unique string identifying the specific error. example: parameter_missing message: type: string description: A human-readable description of what went wrong. example: The 'name' parameter is required for this request. doc_url: type: string description: >- A direct link to the documentation page for this specific error code. example: https://docs.altostrat.io/errors/parameter_missing NotifiableRecipient: type: object required: - id - channel properties: id: type: string format: uuid description: >- The unique identifier of the user (from the Identity service) to be notified. example: usr_5f0b6e1b-4f1e-4b4a-8b0a-0e6f0b6e1b4f channel: type: string description: The delivery channel for the notification. enum: - email - whatsapp example: whatsapp securitySchemes: OAuth2: type: oauth2 description: >- Altostrat uses OAuth2 for authentication. Tokens can be obtained from the Altostrat Authentication API. flows: authorizationCode: authorizationUrl: https://auth.altostrat.io/oauth/authorize tokenUrl: https://auth.altostrat.io/oauth/token scopes: notification:view: Allows viewing notification configurations. notification:create: Allows creating new notification configurations. notification:update: Allows updating existing notification configurations. notification:delete: Allows deleting notification configurations. ````