Skip to main content
GET
List notifications

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

page
integer
default:1
per_page
integer
default:25
Required range: x <= 100
unread
boolean

Only unread notifications

type
string

Filter by notification type

Example:

"new_message"

channel
string

Filter by related channel

Example:

"whatsapp"

include_hidden
boolean
default:false

Also return notifications of hidden types

user
string<email>

Filter by the member's email address (workspace token only)

Response

Notifications retrieved

success
boolean
Example:

true

message
string
Example:

"Notifications retrieved"

data
object