Skip to content
Gospl Wiki

The caller's in-app notification feed (newest first).

GET
/notifications
 
curl --request GET \
  --url 'https://api.gospl.example/v1/notifications?unreadOnly=false&page=1' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
unreadOnly
boolean
page
integer
default: 1 >= 1

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
items
required
Array<object>
object
id
required
string format: uuid
type
required

Seed registry; grows per feature. See spec §2.

string
Allowed values: weekly_summary.submitted weekly_summary.response weekly_summary.reminder weekly_summary.monday_digest weekly_goals.non_setter
title
string
body

Rendered in-app body.

string
link

Deep link into the relevant Gospl page.

string
read
required
boolean
createdAt
required
string format: date-time
page
required
integer
totalPages
required
integer
Example 
{
  "items": [
    {
      "type": "weekly_summary.submitted"
    }
  ]
}

401

Section titled “401 ”

Missing/invalid credentials.

Media type application/json
object
code
required
string
message
required
string
Example generated
{
  "code": "example",
  "message": "example"
}