---
id: notification-event-list
title: "List events"
description: "List all notification events."
sidebar_label: "List events"
hide_title: true
hide_table_of_contents: true
api: eJzlWG1zG7cR/is7+NBJ1CNFUpSt3sSZUV0nVadxPbY0SStrmOXdkkSEA84AThLD4X/vLHBH3pG0rLh1O9N+oXR4ffbB7rPArkROLrOy9NJokYq/SucBlQJtvJzJDLkd6I60d32RCFOSDW0XuUhFe9AkDEqVdF4kwuPcifRavOJGcZMIR1llpV+K9HolpoSW7HnlFyK9vlnfJKJEiwV5si4MkIzlQ0V2KRKhsSDezGqRCJctqECRroRfltzsvJV6LtaJsPShkpZykXpbUbJj2XdS8fKHDAO/QA8F+mwBxgJagsJYAldSxmO5X4NfEJTW3Mmccnj99jXTQQ9YlIphGDtHLX8Ny74YpphlptL+xShl9K7EjF6ciHWyY9qeNVNjFCEbmtMMK+VFOkPlaL2hwS3M/YRNI52j9k60DQ9jdy3/cUF+QRa8AakzVeV0kISZNQVsFwZLzlQ2Iwdm9rjxNcJ/3bYa3sSSq9RnmvZzPflnkPHMLLnSaEdPgNxQHOwWv8WDpkveS1qIc/vwd1NBhhocKco8GE3sWtGtaloD4YyQY6b/Xn8LR0evjaf06AguIvajo7f0oSLnj46gRE0qgUzJ7BZQ55BbnPOilSP45naaf/vSW/XNMf8Hx3VLkdcNv68netNAKirlZak2ePrv9SHCnV8GB58ZWwQGS2VyamJs75DRWmQqC6kvPBVOpMNEFPjQfAwSIeO/uxGcCNJVwaKBiiyLCJbscqj43yqXPgzxLCIdwWBxsXcynJgnRQV5uxQ363U7PqORL5olf1d/NzM/6goefeUe0Z0taldlGTkeO0OpxM36k977NIcKCLpi02zFytm4d2B0NBjwn+42lwuCjW7DPTqo588qxetmRntW6XTFjKsayPEvjmevWpaXlpfxMu5V4pwJ2DJipr9QxofUHWdmM0e+NU5qT3Oye/HFOJ1H6zeCE3aAe6lzc9+HH6SWRVWAdDDos+ArWcinLPwDPoSJuiqmZHn14CVB+Q1Y8lbSHUFJFjJUqg/NBOlgNOC91uEwoyjt+/quQ2+I2J7/tZA5e1XMYY2+hLPmE7CEnvIJ8sfG5bYqGE7oIeTRLrcyP+SRHKroRSqqKuzaZeMc3NJ5Knr3MieotPxQEVz8CWbGBtbb3piwiF5dxd4CfdcNh8OzQZYPRr1hdvKsNx49H/fO6Dn2xuOzk+nZczqbjTiyGnv3idsFxkLIx9MoZMjLu5ggW6DWpOBeKhWmkAZv+vAKs0U9FSyVllw4Ymzl8WVJvH57uY5J11vNuXmKUG0FaitBjVQ1KraRrK02deSLhcJL31Ip5gyzyMr+5vtBw1rVxEycB8bKudTsVLWSNImpjT4MTaV2HnVGk1upVBpdMYpvIwWtRrYtVSbiKJVZchht+1tt91buNE3m1lTldvDcYntugyPN0aNIhDLz1BKyAzNrMms66q/6prlhMs1JUVhp2xQOusN3WLLnKLMUQqvdEXWg0+i8sRTk35S0xRo/NxvGT0s7/c6bcvPR8FE7Slqzv5ni0c5ph6ObdrQd4rvxm9pb1hv1eJLfxLGN5+wFxUfy2sFE1NGwxyQpR089L4v96xUjunj3Nzh7NhjC1eVL4FHOY1HW0iTdxwNXjAajcY+l6A+Xw1F6Mk5Pn/2DYVVl/oVhESh0HuJGnFA+E2l8Mu0nkV2RvKVl7w5VRVBgGQ4P5w7QOZPJEPD30i8On2iDYbVRrglnkOHoZFy76cSpah6c7Y6UKdnbetVtbzg6EY/nQF0phVNFhx9f5xrCQIZbrxHYI5bsRs/3hD5cVUh7VveOSq9Esew5hdltr54cLhq3zeZslGCrTp+J9ZoFtsmgn+ZXQ+wBnoJS8w0E81xyPyqoFzqYLfuBoyYm2z3xBnGohx/c3LtOxPinn/Yvby+VZAbIWmM3TxkHeUXx0XOHSuYgdVn58MCQzjHibX75TTe8xy4wUS1e8uU/EQFP0GLncE77N5PW6E9f0P58efmmUaPM5K30zbaE7NWk8KzNx1fUn/cTGA8G/DPknxP+GX/d8ZfxYBBcoIPlI7p4DgVmC6mpx4mCPbreK+AKF5IMPc2Nlb+GGwoBKzpZYHWsbPeZKaaYT2x8wnGMR9qeAGJqJc0SWFQF6i2S1qhGtSO4cLGp2Xgv/og51O/G94IbrjRWfhEg5+9Fl5z2aIbYnOinQW6DIiePUjnAqan8FlZ3n8vwFg/7hMguULH8Ug6B3RBslG9cuu3B63WMkNNDEfIu0r8bIVLnwc85fDVI5yoCE1/V528uwMmc/sdCw7WJqJ3hlEPjdDDin5PuwZ/+96KCjbUa1SQOmkTK/mPxcVFvD7XrvOIxMVLexdsZXGm8Qxky2l7AHJz+RUPnXEOl6aGkjPN7NMlkWWUt5X14owgdgbdLwDlKDQo92SZqAi6/MJwS5xRvzFx3FcedBBUvpk39tbJKpGLhfenS42MsZZ/ze6nQc8j2M1OE2kNT1H3HURKdu13a3dDACzU1lKCKYZBI6n++a25hf/nxMqRQqWeGpzOeyNiwP+gPWhfe153kmojSOF9gCNm6chMq2bGYssv/ahv1nyx41xZwzj8uFcqwW6BnVRN53c30N4lYGOe5fbWaoqMrq9Zrbo6lJaY3l4496yN1oTa8r97WMvM1fJEC9kHzbmm5qbeHm6ZIRaiQPR33l6o5P4L3QGH83wf+0aryI6D2K9qfien/ovj82Ok2NbMvyt+m1voYkqY+t0Vywx9WxvfPNb83FoQ52RDscdZ5llHpW7P2bhu8ykapv391GcotHRndkc2wevMM08vW2qtVHHFpbkmv16KB7vlbrG/W6/U/AQaxs48=
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 events"}
>
</Heading>

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



List all notification events.

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

<ParamsDetails
  parameters={[{"in":"query","name":"nrn","schema":{"type":"string"},"required":true,"description":"Filters notification events that match or are more specific than the provided NRN.","example":"organization=1:account=2:namespace=3"},{"in":"query","schema":{"type":"boolean","default":false},"name":"show_descendants","required":false,"description":"Whether to include notification events from descendant resources of the provided NRN.","example":false},{"in":"query","schema":{"type":"boolean","default":false},"name":"include_results","required":false,"description":"Whether to include `results` in the response.","example":false},{"in":"query","name":"source","description":"Filters notification events by their source. You can select one or more sources from the list.\n> **Note:** In the **Request** panel, click and drag or use <kbd>Ctrl</kbd> / <kbd>Cmd</kbd> + click to select multiple sources.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","enum":["alert","approval","audit","entity","parameters","service","telemetry"]}},"example":"source=approval&source=service"},{"in":"query","name":"status","schema":{"type":"string","enum":["success","fail"]},"required":false,"description":"Filters notification events by their status.","example":"success"}]}
>
  
</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."}}},"results":{"type":"array","items":{"type":"object","required":["id","nrn","source","event","created_at","status","results","context"],"properties":{"id":{"type":"string","format":"uuid","description":"A system-wide unique ID for the notification, in UUID format.","example":"1180cd02-1c36-4274-8e7a-4483b87e8f2e"},"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"},"action":{"type":"string","description":"The name of the action originated by the source.","enum":["action:instance_kill:create","application:create","audit:log","deployment:create","deployment:write","deployment_group:create","grant:create","instance:data","log:read","metric:data","metric:list","parameter:delete","parameter:notify","parameter:read-secrets","parameter:retrieve","parameter:store","scope:create","scope:delete","scope:recreate","scope:stop","scope:write","service:action:create","target_group:create"],"example":"deployment:create","title":"action"},"status":{"type":"string","description":"The status of the notification.","enum":["success","fail"],"example":"success"},"created_at":{"type":"string","format":"date-time","description":"The ISO 8601 UTC timestamp for this notification.","example":"2024-02-19T12:34:56Z"},"updated_at":{"type":"string","format":"date-time","description":"The ISO 8601 UTC timestamp for the last update to this notification.","example":"2024-02-19T12:34:56Z"},"tags":{"type":"object","description":"A key-value map of tags associated with the notification.","example":{"approval_id":1234,"scope_slug":"development-uk-123"}},"results":{"type":"array","nullable":true,"description":"An array of results for each channel the notification was sent to.","example":[{"my-slack-channel":{"ok":true,"id":"123456"}}]},"context":{"type":"object","description":"An object containing additional context for the notification."}},"title":"notification"}}},"title":"notificationList"}}}},"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>