notifications

4 endpoints at a glance

Method	Path	Summary
GET	/notifications	List Notifications
POST	/notifications/{notification_id}/read	Mark Read
POST	/notifications/read-all	Mark All Read
GET	/notifications/unread-count	Unread Count

notifications

---

List Notifications

GET

/notifications

Parameters

Header Parameters

authorization

Query Parameters

unread_only

Type

boolean

Default

false

page

Type

integer

Default

1

limit

Type

integer

Default

50

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notifications

Playground

Headers

authorization

Variables

Key

Value

unread_only

page

limit

Samples

---

Unread Count

GET

/notifications/unread-count

Cheap endpoint for the nav-bar bell badge to poll.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/notifications/unread-count

Playground

Headers

authorization

Samples

---

Mark Read

POST

/notifications/{notification_id}/read

Parameters

Header Parameters

authorization

Path Parameters

notification_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notifications/{notification_id}/read

Playground

Headers

authorization

Variables

Key

Value

notification_id*

Samples

---

Mark All Read

POST

/notifications/read-all

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/notifications/read-all

Playground

Headers

authorization

Samples

---