---
id: notification-channel-list
title: "List channels"
description: "List notification channels by NRN."
sidebar_label: "List channels"
hide_title: true
hide_table_of_contents: true
api: eJzdWm1v2zgS/isEscC1hey4aXK7ayAHuEl2m702DRp3r4ckSGlpbHNLkSpJJfEa/u+HISmZstVY7e3eHe6LY0sczswzL5wZZkkzMKnmheVK0iF9zY0lUlk+5SnDZySdMylBGDJZkPN3532aUFWAdi/PMjqk8erbsHoouLE0oZbNDB1e0WP/mN4k1EBaam4XdHi1pBNgGvSotHM6vLpZ3SS0YJrlYEEbt4CjUJ9L0AuaUMlyQIZa0oSadA45o8MltYsCHxuruZzRVUI1fC65howOrS4h2VBxPAdUhKgpsXMgGowqdQrkCZepKDMuZySdc5FpkPVL85Tcz0GDo2CpA+aeC0FYUYhFQkyZzgkzROkZk/x3h0VCWJqqUtqEoOCmYCkkjiCAlRAmM2JSVQCiCg8sLwRqEu9y9HwYtjnaH9b7HB0Mo42ODoZul6NDukraMXMYxchMmTCt0OBKxKbNCfqP4J5QkGWOxjaCpZ9oQufWFjShM27n5cR/EQy/sN9LjdKwGUhLb1ax7p4YPUGDKZQ0YJDX/mCAf7bFrX2R3DODdkjBmGnpRE2VtMhhuKQRWnu/GaReRpoUGrex3PMq2AwVWmuoJr9Biu7cXKemUwM2WselhRlo2garsUzbyuc8B3LPZabu++QNlzwvc8INGfTRgQXPeZeN37AHRyjLfAIadwcBOUhriFVEg9Uc7oAUoEnKhOiTioAbsj/wvKyyTHRRAte1cpozS1ImyQRqllmfrlYuEk0prIm2Z1oz9EtuITdtGK9d9IryDD3YhXtw4FTJKZ+V3uSYTpom4VlHc5SSfy6BnJ2QqdLOJl/y99o1v//hx5WXpsX3/+wU89UJ4kUzQaClGzLuUmEkiXLfmSDRm+5w0TeL6rkjYkWh1R26UERpUC6vf4uPbEhE8FBBTANg3vO+JIwHD0lAEqv65JSl80BKNBQajHNfRkwBKZK3pr6GTle00gJdb9OFtxJhvRhPPX3HU5f0yoyjnzMB2rrFFk/DhFoXUdZl7egUxPRoufXJ0SO1CuHQyQ935fPN1PvteXwtp5NqtRmtLcG+LW6DhPiFO51OSXg7dfXC4xm7qmU65KN1NbEVF44EIb1EgOoCacNTZClEIZidKp33Kk9Ac8bHXSzSFc0XvTiye4Xmd8xCL62qp9gV/DmZ7FK51KKbn7x/9zpKQI0g9aE0AYIR0/QZ9A0z3NvLF71M5YzLfqpy/NXYoIdSrBI6B5a5yq6LJ4TFeJIF1uSe23nIqJ9LME1ZlhTrSKUDenRIX7rqEgl6Vn0C6c+kiMCBU+uwUKWOlCi16C1U2as8EvAwijTowG1tLhdDu63FpbFMCF9LNw6zRyz3M7evygmJacnZSdNO+aIXv+/xDO0RDo6vYhNoiNKNaneLnU8X6NC+JC+U4VbpxVcxW5NtpCqfTk1PFSCtmpaexxQ0yLRjYqyXo4fZ3TzRMZDNvdKfpkLdd7bP2UlVCAQO1Q7N/TFDcMOV5HLWX+SCbjjrlm+0GTWy6YYRmjZoQbABoNd2Q9kWEdceHo6H3T7+B5jpNZuQQivcvk/Gc26q+tMV1/6Fa7rQS7dCIdgxrPs2M8YSNHZ/vv/iYNNyLbjGzANNA0o8YHdDGQdgNyVGeGSTE7h7W5jH49cd7lX4BnG/gUcrSPX21b7IghcguITbzjX82iBNjmGjBkuE+A9IEbsZBfdqOkDTTk10I3C3cdmABbVoCdPIdXxJtttzWMFvP0HHZDy6OCOfYFGXYa7ea2o9Go1GfRTv8K/f//DjgE3SDKabvy/G5siXhXnOZLa7DDhxvyau1MfS0JGtRfB1CTxAWlpnhaaOGbOsa9Hpd0ag3VAG5B3XSmKDS+6Y5mwiwGxzSPMMSbqh2GDii5ogeta/ln8jz56dKwvPng3J2I0IsNRRDcUdpZmrUmSkUFzaasFUiQx03D86eLipigLHonnaMDvvWdUDafXCbdabcgF769+k1wuHRA8XH13T7y5P3/16dnx6ezEav7qmaMoIqG5QtyJbe1bQtAWPdroAxgQIlwEJnTNLPv799J9D8uvo9fvTjxuaL+n5xe3oeHz29vz2+O35+PTDmA7pX75bnr8dn/10djyK36xcJDM9K92s49/oG1CHep9g/oIZA1mblTdkvkIRnlMnyT62EI90gFX3hr6FPdmXHbHqDNch3YT9uNQapMX5Ji5RUiyIKYtCaQuBmhvyERltguy5OzkNCEit0t3co1q9kWs2TdhwOypUyoTnVudB15KusGOacmE7NR0jMhXwwCcCqr7TDRhKA4a8UXKmTl4SN1YlZiEte0DDZTDFoEw1t6A5c2J7hjjkaTRB/WvZxPcSgFydxy1tEPXmyV6mUrPXIN8LL586HrnS6PNTtdEC+cERHdIMCqEWCNAw1cAsNPGJt66G840F4SHeB+CLVUIPPnzYHsEeC44RCVorTeqJLclKl+K4vGOCZ4TLonQdQ86NQWDW842vmtM+Nis0ltnSHKsMJxJOHprQHIxhM9geFEardxcbr8bjC+IpSKqyaHyEuqCX1iOkNMbjCfRn/YQcDAb48Rw/XuDHwdOG1Q4GA3coZh0OkhHJWTrnEnoaWIZJMPBycoVRrIUZNqbh2MQkDppMGRel3ihWJiy7Db20y+YOtg5CTDSHaULmZc7kWpJ4ThjyihfO5YqAxjV9yTLyzjO9pvjgvWShl4bsmjbBiVejiJVFdwuZZbyeX1rGhSFsokq7FqvJZ7weK7irhJwJPEwgIw5daRmXkNUuHXvwauUj5LAtQi49/JsRwmXm/FzOCJOEG1NihvVF5sUZMTyD/7PQMDEQwRkOMTQOB/v48aJp+MP/XlSgsloycesX3XrI/mPxcRbYk+A6p7jGR8qlL8jIe8nuGBe461bAtJL/qaEzkqSU8FBAioWBV0mlKZYPWZ9cCGAGiNULwmaMSyKYBV1FjZPLzhX2wTNwjQrD22DaOP32qhGon6RXt8PN+R0reD+euuIUz90kVlfOlxgt3snji+cajjDodkHlsqNbRJPw5SdXW9Ih/eUfY1cX4vmL5CiPR+55f9Af0PUpGp/urslVxubMhW64mHUX7vUQeOuSpo7/bjfzQRELD3avEKE3DCNgj+tV4+jHDLO+mp8rY3HFcjlhBt5rsVrhY3+VjHhn3KDLfeH6OJb2ybuQf56S/9X79lasXE8crhzvmChxhWunu6ve5dLlEd7honPN/AZ/+IbH/ZNENYR2FvE0ozSFwkZUW2cF7lLH2c+nY3cR1XD+DWePb1OYXER7L5d+xRiH3KsVrQX3Q2/sTv4FhFDw2w==
sidebar_class_name: "get api-method"
info_path: docs/api/notification
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List channels"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/notification/channel"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List notification channels by NRN.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"nrn","schema":{"type":"string"},"required":true,"description":"The NRN of the resource (including children resources) where the action will apply, such as organization, account, namespace, application, and scope.","example":"organization=1:account=2:namespace=4:application=4:scope=5"},{"in":"query","name":"type","required":false,"description":"The type of notification channel.","schema":{"type":"string","enum":["slack","http","github","gitlab","azure","agent"]},"example":"slack"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"properties":{"paging":{"type":"object","properties":{"offset":{"type":"integer","description":"The start of the paging window. Minimum is 0."},"limit":{"type":"integer","description":"Maximum number of elements to retrieve per call. Maximum is 200."},"total":{"type":"integer","description":"Total number of elements that can be retrieved."}}},"results":{"type":"array","items":{"type":"object","required":["id","nrn","type","configuration"],"properties":{"id":{"type":"integer","description":"The unique ID for the notification channel.","example":789},"nrn":{"type":"string","description":"The NRN of the resource (including children resources) where the action will apply.","example":"organization=1:account=2:namespace=3:application=4"},"description":{"type":"string","description":"An optional description for the notification channel.","example":"My channel for approval notifications"},"source":{"type":"array","description":"A list of sources that the notification channel will listen to. Each source represents a specific type of notification.","example":["approval"],"items":{"type":"string","enum":["approval","service","audit","alert","entity","telemetry","parameters"]},"title":"source"},"type":{"type":"string","description":"The type of notification channel.","example":"slack","enum":["slack","http","github","gitlab","azure","agent"],"title":"type"},"configuration":{"type":"object","description":"The configuration object for the notification channel.","oneOf":[{"type":"object","properties":{"channels":{"type":"array","items":{"type":"string"},"description":"An array of Slack channels.","example":["nullplatform-approvals"]}},"example":{"channels":["my-organization-private-channel"]},"title":"slack"},{"type":"object","properties":{"url":{"type":"string","description":"The URL where the notifications will be sent.","example":"https://my-domain.com/my-notifications-url"},"headers":{"type":"object","description":"The headers to be sent with the request.","example":{"Authorization":"Bearer the-token"}}},"example":{"url":"https://yourdomain.com/url-you-configured","headers":{"Authorization":"Bearer the-token"}},"title":"http"},{"type":"object","properties":{"installation_id":{"type":"string","description":"The GitHub installation ID.","example":"my-installation-id"},"account":{"type":"string","description":"The GitHub account or organization.","example":"my-github-org"},"repository":{"type":"string","description":"The GitHub repository.","example":"services-opentofu"},"reference":{"type":"string","description":"The reference to the GitHub repository.","example":"main"},"workflow_id":{"type":"string","description":"The ID of the GitHub workflow.","example":"provisioning.yml"}},"example":{"installation_id":"my-installation-id","account":"my-github-org","repository":"services-opentofu","reference":"main","workflow_id":"provisioning.yml"},"title":"github"},{"type":"object","properties":{"reference":{"type":"string","description":"The reference to the GitLab project. This can be the project name or ID.","example":"main"},"project_id":{"type":"string","description":"The ID of the GitLab project.","example":"1234"}},"example":{"reference":"main","project_id":"1234"},"title":"gitlab"},{"type":"object","properties":{"organization":{"type":"string","description":"The Azure DevOps organization.","example":"my-azure-org"},"project":{"type":"string","description":"The Azure DevOps project.","example":"my-azure-project"},"pipeline_id":{"type":"integer","description":"The ID of the Azure DevOps pipeline.","example":1234},"reference":{"type":"string","description":"The reference to the Azure DevOps pipeline.","example":"main"}},"example":{"organization":"my-azure-org","project":"my-azure-project","pipeline_id":1234,"reference":"main"},"title":"azure"},{"type":"object","properties":{"api_key":{"type":"string","description":"The API key for the agent.","example":"AAAA.1234567890abcdef1234567890abcdefPTs="},"command":{"type":"object","description":"Describes the command the agent will execute.","properties":{"data":{"type":"object","description":"The command line and environment variables.","properties":{"cmdline":{"type":"string","description":"The command line to be executed.\n> **Note**: The path to the command line should point to the folder where the agent is installed.\n","example":"path-to-entrypoint-file/entrypoint --service-path=\"$SERVICE_PATH\""},"environment":{"type":"object","description":"The environment variables for the command.\n> **Note**: The environment variables should be in the format `KEY: VALUE`.\n","example":{"NP_ACTION_CONTEXT":"'${NOTIFICATION_CONTEXT}"}},"arguments":{"type":"array","items":{"type":"string"},"description":"The arguments to be passed to the command line.\n","example":["arg1","arg2"]}}},"type":{"type":"string","enum":["exec"],"description":"The command type of the agent.\n> **Note**: Currently, the only supported type is `exec`.\n","example":"exec"}}},"selector":{"type":"object","description":"The selector for the agent.\n","example":{"environment":"local"}}},"title":"agent"}]},"filters":{"type":"object","description":"A flexible object that uses MongoDB query syntax to define criteria for filtering notifications.\n\n> **Note**: See [Notification filters](/docs/notifications/filters) for more info.","example":{"action":"deployment:create"}}},"title":"notificationChannel"}}},"title":"ChannelList"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>