NOnovu
Channel Connections

List all channel connections

Changed on

List all channel connections for a resource.

get/v1/channel-connections

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Query parameters

afterstring

Cursor for pagination indicating the starting point after which to fetch results.

beforestring

Cursor for pagination indicating the ending point before which to fetch results.

limitnumber
Example:10

Limit the number of items to return (max 100)

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

subscriberIdstring
Example:subscriber-123

The subscriber ID to filter results by

connectionMode'subscriber' | 'shared'
Example:shared

Scope results relative to the subscriber. subscriber returns only the subscriber-owned connections, shared returns only shared (workspace-level) connections. Omit to return both.

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'
Example:chat

Filter by 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' | 'agent-email-inbox' | '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' | 'google-chat' | 'msteams' | 'webex-messaging' | 'mattermost' | 'ryver' | 'zulip' | 'grafana-on-call' | 'getstream' | 'rocket-chat' | 'whatsapp-business' | 'line' | 'chat-webhook' | 'novu-slack' | 'telegram' | 'sendblue' | 'photon-imessage' | 'novu-web-chat' | 'anthropic' | 'novu-anthropic' | 'anthropic-aws' | 'pagerduty' | 'opsgenie' | 'grafana' | 'tool-webhook'

Provider ID of the execution

Filter by provider identifier (e.g., sendgrid, twilio, slack, etc.).

integrationIdentifierstring
Example:slack-prod

Filter by integration identifier.

contextKeysstring[]

Filter by exact context keys, order insensitive (format: "type:id")

[
  "tenant:org-123",
  "region:us-east-1"
]

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

nextstring nullable required

The cursor for the next page of results, or null if there are no more pages.

previousstring nullable required

The cursor for the previous page of results, or null if this is the first page.

totalCountnumber required

The total count of items (up to 50,000)

totalCountCappedboolean required

Whether there are more than 50,000 results available

Example response

{
  "data": [
    {
      "providerId": "slack",
      "integrationIdentifier": "slack-prod",
      "subscriberId": "subscriber-123",
      "contextKeys": [
        "tenant:org-123",
        "region:us-east-1"
      ],
      "workspace": {
        "id": "T123456",
        "name": "Acme HQ",
        "botUserId": "U0123456789"
      },
      "auth": {
        "accessToken": "Workspace access token",
        "refreshToken": "Workspace refresh token",
        "expiresAt": "2026-06-15T12:00:00.000Z",
        "refreshTokenExpiresAt": "2026-09-15T12:00:00.000Z"
      }
    }
  ]
}

Changes

  • 951a80501fceRevision changes
    • warning

      added the new agent-email-inbox enum value to the // response property for the response status

    • info

      added the new enum value agent-email-inbox to the query request parameter providerId

  • f056922796adRevision changes
    • warning

      added the new google-chat enum value to the // response property for the response status

    • warning

      added the new photon-imessage enum value to the // response property for the response status

    • info

      added the new enum value google-chat to the query request parameter providerId

    • info

      added the new enum value photon-imessage to the query request parameter providerId