Channel Connections

List all channel connections

List all channel connections for a resource.

get/v1/channel-connections

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/channel-connections
  • 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

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

The subscriber ID to filter results by

connectionMode'subscriber' | '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'

Filter by channel type (email, sms, push, chat, etc.).

providerId'anypost' | 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'nodemailer' | 'postmark' | 'sendgrid' | 'sendinblue' | 'ses' | 'netcore' | 'infobip-email' | 'resend' | 'sendly' | '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' | 'web-push' | '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

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

integrationIdentifierstring

Filter by integration identifier.

contextKeysstring[]

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

Response

OK

Example response

{
  "data": {
    "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

No recorded changes to this operation across all 1 revision of this API.