---
title: "List notification channels"
method: GET
path: "/api/v1/notification/channels"
tags: ["Notifications"]
---

# List notification channels

`GET /api/v1/notification/channels`

List all notification channels.

## Query parameters

- `includeDeleted` boolean
- `includeDisabled` boolean
- `page` integer
- `pageSize` integer
- `order` 'ASC' | 'DESC' — The order direction.
- `orderBy` 'id' | 'type' | 'createdAt' | 'updatedAt' — Order by options for notification channels.

## Response `200`

The request has succeeded.

- NotificationChannelPaginatedResponse — Paginated response
  - `totalCount` integer, required — The total number of items.
  - `page` integer, required — The page index.
  - `pageSize` integer, required — The maximum number of items per page.
  - `items` NotificationChannel[], required — The items in the current page.
    - `createdAt` string, date-time, required — Timestamp of when the resource was created.
    - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated.
    - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted.
    - `id` string, required — Identifies the notification channel.
    - `type` 'WEBHOOK', required — Notification channel type.
    - `name` string, required — User friendly name of the channel.
    - `disabled` boolean — Whether the channel is disabled or not.
    - `annotations` Annotations — Set of key-value pairs managed by the system. Cannot be modified by user.
    - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource.
    - `url` string, required — Webhook URL where the notification is sent.
    - `customHeaders` object — Custom HTTP headers sent as part of the webhook request.
    - `signingSecret` string — Signing secret used for webhook request validation on the receiving end. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. Recommended size: 24

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
- `401` — The request has not been applied because it lacks valid authentication credentials for the target resource.
- `403` — The server understood the request but refuses to authorize it.
- `412` — One or more conditions given in the request header fields evaluated to false when tested on the server.
- `500` — The server encountered an unexpected condition that prevented it from fulfilling the request.
- `503` — The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/openmeterio/apis/openmeter-api.md) · [All operations](https://skmtc.net/openmeterio/apis/openmeter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openmeterio/openmeter-api/versions/927d82ffe647/schema)