---
title: "List all channel connections"
method: GET
path: "/v1/channel-connections"
tags: ["Channel Connections"]
---

# List all channel connections

`GET /v1/channel-connections`

List all channel connections for a resource.

## Query parameters

- `after` string
- `before` string
- `limit` number
- `orderDirection` 'ASC' | 'DESC'
- `orderBy` string
- `includeCursor` boolean
- `subscriberId` string
- `connectionMode` 'subscriber' | 'shared'
- `channel` 'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'
- `providerId` 'anypost' | 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'nodemailer' | 'postmark' | 'sendgrid' | 'sendinblue' | 'ses' | 'netcore' | 'infobip-email' | 'resend' | 'plunk' | 'mailersend' | 'mailtrap' | 'clickatell' | 'outlook365' | 'novu-email' | 'sparkpost' | 'email-webhook' | 'braze' | 'novu-email-agent' | 'nexmo' | 'plivo' | 'sms77' | 'sms-central' | 'sns' | 'telnyx' | 'twilio' | 'gupshup' | 'firetext' | 'infobip-sms' | 'burst-sms' | 'bulk-sms' | 'isend-sms' | 'forty-six-elks' | 'kannel' | 'maqsam' | 'termii' | 'africas-talking' | 'novu-sms' | 'sendchamp' | 'generic-sms' | 'clicksend' | 'bandwidth' | 'messagebird' | 'simpletexting' | 'azure-sms' | 'ring-central' | 'brevo-sms' | 'eazy-sms' | 'mobishastra' | 'afro-message' | 'unifonic' | 'smsmode' | 'imedia' | 'sinch' | 'isendpro-sms' | 'cm-telecom' | 'ruach-sms' | 'fcm' | 'apns' | 'expo' | 'one-signal' | 'pushpad' | 'push-webhook' | 'pusher-beams' | 'appio' | 'novu' | 'slack' | 'discord' | 'msteams' | 'webex-messaging' | 'mattermost' | 'ryver' | 'zulip' | 'grafana-on-call' | 'getstream' | 'rocket-chat' | 'whatsapp-business' | 'line' | 'chat-webhook' | 'novu-slack' | 'telegram' | 'sendblue' | 'novu-web-chat' | 'anthropic' | 'novu-anthropic' | 'anthropic-aws' | 'pagerduty' | 'opsgenie' | 'grafana' | 'tool-webhook' — Provider ID of the job
- `integrationIdentifier` string
- `contextKeys` string[]

## Headers

- `idempotency-key` string

## Response `200`

OK

- ListChannelConnectionsResponseDto
  - `data` GetChannelConnectionResponseDto[], required — List of returned Channel Connections
    - `identifier` string, required — The unique identifier of the channel endpoint.
    - `channel` 'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool', nullable, required — The channel type (email, sms, push, chat, etc.).
    - `providerId` 'anypost' | 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'nodemailer' | 'postmark' | 'sendgrid' | 'sendinblue' | 'ses' | 'netcore' | 'infobip-email' | 'resend' | 'plunk' | 'mailersend' | 'mailtrap' | 'clickatell' | 'outlook365' | 'novu-email' | 'sparkpost' | 'email-webhook' | 'braze' | 'novu-email-agent' | 'nexmo' | 'plivo' | 'sms77' | 'sms-central' | 'sns' | 'telnyx' | 'twilio' | 'gupshup' | 'firetext' | 'infobip-sms' | 'burst-sms' | 'bulk-sms' | 'isend-sms' | 'forty-six-elks' | 'kannel' | 'maqsam' | 'termii' | 'africas-talking' | 'novu-sms' | 'sendchamp' | 'generic-sms' | 'clicksend' | 'bandwidth' | 'messagebird' | 'simpletexting' | 'azure-sms' | 'ring-central' | 'brevo-sms' | 'eazy-sms' | 'mobishastra' | 'afro-message' | 'unifonic' | 'smsmode' | 'imedia' | 'sinch' | 'isendpro-sms' | 'cm-telecom' | 'ruach-sms' | 'fcm' | 'apns' | 'expo' | 'one-signal' | 'pushpad' | 'push-webhook' | 'pusher-beams' | 'appio' | 'novu' | 'slack' | 'discord' | 'msteams' | 'webex-messaging' | 'mattermost' | 'ryver' | 'zulip' | 'grafana-on-call' | 'getstream' | 'rocket-chat' | 'whatsapp-business' | 'line' | 'chat-webhook' | 'novu-slack' | 'telegram' | 'sendblue' | 'novu-web-chat' | 'anthropic' | 'novu-anthropic' | 'anthropic-aws' | 'pagerduty' | 'opsgenie' | 'grafana' | 'tool-webhook', nullable, required — The provider identifier (e.g., sendgrid, twilio, slack, etc.).
    - `integrationIdentifier` string, nullable, required — The identifier of the integration to use for this channel endpoint.
    - `subscriberId` string, nullable, required — The subscriber ID to which the channel connection is linked
    - `contextKeys` string[], required — The context of the channel connection
    - `workspace` WorkspaceDto, required
      - `id` string, required
      - `name` string
      - `botUserId` string
    - `auth` AuthDto, required
      - `accessToken` string, required
      - `refreshToken` string
      - `expiresAt` string
      - `refreshTokenExpiresAt` string
    - `createdAt` string, required — The timestamp indicating when the channel endpoint was created, in ISO 8601 format.
    - `updatedAt` string, required — The timestamp indicating when the channel endpoint was last updated, in ISO 8601 format.
  - `next` string, nullable, required — The cursor for the next page of results, or null if there are no more pages.
  - `previous` string, nullable, required — The cursor for the previous page of results, or null if this is the first page.
  - `totalCount` number, required — The total count of items (up to 50,000)
  - `totalCountCapped` boolean, required — Whether there are more than 50,000 results available

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Conflict
- `413` — Payload Too Large
- `414` — URI Too Long
- `415` — Unsupported Media Type
- `422` — Unprocessable Entity
- `429` — The client has sent too many requests in a given amount of time.
- `500` — Internal Server Error
- `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.

---

[API](https://skmtc.net/novu/apis/novu-api.md) · [All operations](https://skmtc.net/novu/apis/novu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/novu/novu-api/revisions/e4a270f838f0/schema)
