List channel endpoints
Retrieve all channel endpoints for a resource based on query filters.
Authorization
Authorization<token>API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
In: header
Authorization<token>API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
In: header
Query Parameters
afterstringCursor for pagination indicating the starting point after which to fetch results.
beforestringCursor for pagination indicating the ending point before which to fetch results.
limitnumberLimit the number of items to return (max 100)
100orderDirectionstringDirection of sorting
"ASC" | "DESC"orderBystringField to order by
includeCursorbooleanInclude cursor item in response
subscriberIdstringThe subscriber ID to filter results by
contextKeysarray<string>Filter by exact context keys, order insensitive (format: "type:id")
channelstringChannel type to filter results.
"in_app" | "email" | "sms" | "chat" | "push"providerIdstringFilter by provider identifier (e.g., sendgrid, twilio, slack, etc.).
"emailjs" | "mailgun" | "mailjet" | "mandrill" | "nodemailer" | "postmark" | "sendgrid" | "sendinblue" | "ses" | "netcore" | "infobip-email" | "resend" | "plunk" | "mailersend" | "mailtrap" | "clickatell" | "outlook365" | "novu-email" | "sparkpost" | "email-webhook" | "braze" | "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" | "fcm" | "apns" | "expo" | "one-signal" | "pushpad" | "push-webhook" | "pusher-beams" | "appio" | "novu" | "slack" | "discord" | "msteams" | "mattermost" | "ryver" | "zulip" | "grafana-on-call" | "getstream" | "rocket-chat" | "whatsapp-business" | "chat-webhook" | "novu-slack"integrationIdentifierstringIntegration identifier to filter results.
connectionIdentifierstringConnection identifier to filter results.
Header Parameters
idempotency-keystringA header for idempotency purposes
Response Body
OK
dataRequiredarray<object>List of returned Channel Endpoints
nextRequiredstring | nullThe cursor for the next page of results, or null if there are no more pages.
previousRequiredstring | nullThe cursor for the previous page of results, or null if this is the first page.
totalCountRequirednumberThe total count of items (up to 50,000)
totalCountCappedRequiredbooleanWhether there are more than 50,000 results available