Skip to main content
GET
List notifications

Authorizations

session
string
cookie
required

Query Parameters

workspace_id
string<uuid>

Filter notifications by workspace

unread_only
boolean
default:false

Return only unread notifications

include_dismissed
boolean
default:false

Include dismissed notifications in results

include_archived
boolean
default:false

Include archived notifications (full history)

only_archived
boolean
default:false

Return only archived notifications

priority
enum<string>

Filter by priority level

Available options:
low,
normal,
high,
urgent

Filter by related entity type

Available options:
reminder,
task,
conversation,
workflow,
contact,
company,
deal,
invite,
message

Filter by related entity ID

limit
integer
default:50

Number of notifications to return

Required range: x >= 1
offset
integer
default:0

Pagination offset

Required range: x >= 0

Response

Notifications list

notifications
object[]
count
integer

Total count matching filters

unread_count
integer

Total unread count

archived_count
integer

Total archived count

limit
integer
offset
integer