> ## Documentation Index > Fetch the complete documentation index at: https://astronomer.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # List Alert Notification Channels > List Alert Notification Channels. ## OpenAPI ````yaml /astro/api/v-1-beta-1/platform/openapi.yaml get /organizations/{organizationId}/notification-channels openapi: 3.0.3 info: contact: {} description: Astro Platform API title: Astro Platform API version: v1beta1 servers: - url: https://api.astronomer.io/platform/v1beta1 security: - JWT: [] tags: - description: >- A `cluster` object represents an Astro cluster, which is a Kubernetes cluster that hosts the infrastructure required to run Deployments. Make requests to `cluster` endpoints to manage your standard and dedicated clusters. See [Create a dedicated cluster](https://astronomer.io/docs/astro/create-dedicated-cluster). name: Cluster - description: >- The `organization` object contains the metadata and configurations of an Astro Organization. It does not include objects within the Organization, such as users and clusters. Make requests to `organization` endpoints to view and update high level settings for your Organization, including settings related to authentication and billing. To manage resources within an Organization, make requests to the endpoints related to those resources, such as `users`. See [Billing](https://astronomer.io/docs/astro/manage-billing), [Set up single sign-on](https://astronomer.io/docs/astro/configure-idp), and [Manage domains](https://astronomer.io/docs/astro/manage-domains). name: Organization - description: >- The `options` object represents all possible configurations for a given Astro component. Make requests to the `options` object to get the configuration constraints for creating or updating a given Astro component. name: Options - description: >- The `workspace` object represents an Astro Workspace, which is a collection of Deployments that can be accessed by a specific group of users. It contains metadata about a Workspace, but does not contain objects within the Workspace such as users and Deployments. Make requests to `workspace` endpoints to manage high level details about your Workspace. To manage resources within a Workspace, make requests to the endpoints related to those resources, such as `users`, and use the `workspaceIds` parameter to filter results by Workspace. See [Configure Workspaces](https://astronomer.io/docs/astro/manage-workspaces). name: Workspace - name: notification-channels x-group: Notification Channels paths: /organizations/{organizationId}/notification-channels: get: tags: - notification-channels summary: List Alert Notification Channels description: List Alert Notification Channels. operationId: ListNotificationChannels parameters: - description: >- The ID of the Organization to which the Notification Channels belong. in: path name: organizationId required: true schema: type: string - description: >- A list of IDs of specific Notification Channels to list. The API will list information only for Notification Channels which have been specified in this list. in: query name: notificationChannelIds schema: items: type: string type: array - description: >- A list of Deployment IDs to filter by, not allowed if Workspace IDs are provided. Returns Notification Channels scoped to these Deployments, plus any shared Organization or Workspace Notification Channels accessible to them. in: query name: deploymentIds schema: items: type: string type: array - description: >- A list of Workspace IDs to filter by, not allowed if Deployment IDs are provided. Returns Notification Channels scoped to these Workspaces, plus any shared Organization or Deployment Notification Channels accessible to them. in: query name: workspaceIds schema: items: type: string type: array - description: A list of Notification Channel types to filter by. in: query name: channelTypes schema: items: enum: - EMAIL - SLACK - PAGERDUTY - DAG_TRIGGER - OPSGENIE type: string type: array - description: The type of entity the Notification Channels belong to. in: query name: entityType schema: enum: - ORGANIZATION - WORKSPACE - DEPLOYMENT type: string - description: The number of results to skip before returning values. in: query name: offset schema: default: 0 minimum: 0 type: integer - description: The maximum number of results to return. in: query name: limit schema: default: 20 minimum: 0 type: integer - description: >- A list of field names to sort by, and whether to show results as ascending or descending. Formatted as `:asc` or `:desc`. in: query name: sorts schema: items: enum: - name:asc - name:desc - createdAt:asc - createdAt:desc - updatedAt:asc - updatedAt:desc type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/NotificationChannelsPaginated' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Error' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal Server Error security: - JWT: [] components: schemas: NotificationChannelsPaginated: properties: limit: description: The maximum number of notification channels to return. type: integer notificationChannels: description: The notification channels. items: $ref: '#/components/schemas/NotificationChannel' type: array offset: description: The offset of the first notification channel in the list. type: integer totalCount: description: The total number of notification channels. type: integer required: - limit - notificationChannels - offset - totalCount type: object Error: properties: message: type: string requestId: type: string statusCode: maximum: 600 minimum: 400 type: integer required: - message - requestId - statusCode type: object NotificationChannel: properties: createdAt: description: >- The time when the alert was created in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string createdBy: $ref: '#/components/schemas/BasicSubjectProfile' definition: description: The notification channel's definition. deploymentId: description: The deployment ID the notification channel is scoped to. type: string entityId: description: The entity ID the notification channel is scoped to. type: string entityName: description: The name of the entity the notification channel is scoped to. type: string entityType: description: The type of entity the notification channel is scoped to. type: string id: description: The notification channel's ID. type: string isShared: description: >- When entity type is scoped to ORGANIZATION or WORKSPACE, this determines if child entities can access this notification channel. type: boolean name: description: The notification channel's name. type: string organizationId: description: The organization ID the notification channel is scoped to. type: string type: description: The notification channel's type. type: string updatedAt: description: >- The time when the alert was updated in UTC, formatted as `YYYY-MM-DDTHH:MM:SSZ`. example: '2022-11-22T04:37:12Z' format: date-time type: string updatedBy: $ref: '#/components/schemas/BasicSubjectProfile' workspaceId: description: The workspace ID the notification channel is scoped to. type: string required: - createdAt - createdBy - definition - entityId - entityType - id - isShared - name - organizationId - type - updatedAt - updatedBy type: object BasicSubjectProfile: properties: apiTokenName: description: >- The API token's name. Returned only when `SubjectType` is `SERVICEKEY`. example: my-token type: string avatarUrl: description: >- The URL for the user's profile image. Returned only when `SubjectType` is `USER`. example: https://avatar.url type: string fullName: description: The subject's full name. Returned only when `SubjectType` is `USER`. example: Jane Doe type: string id: description: The subject's ID. example: clm8qv74h000008mlf08scq7k type: string subjectType: description: The subject type. enum: - USER - SERVICEKEY example: USER type: string username: description: The subject's username. Returned only when `SubjectType` is `USER`. example: user1@company.com type: string required: - id type: object securitySchemes: JWT: scheme: bearer type: http ````