Skip to content
Vespy API

Preview the pending digest email for the current admin user

GET
/api/notifications/digest-preview
curl --request GET \
  --url https://api.getvespy.com/api/notifications/digest-preview \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
preview
required
object
html
required
string
>= 1 characters
notificationCount
required
integer
notifications
required
Array<object>
object
body
required
string
nullable
createdAt
required
string format: date-time
title
required
string
>= 1 characters
recipientName
required
string
nullable >= 1 characters <= 160 characters
subject
required
string
>= 1 characters
text
required
string
>= 1 characters
Examplegenerated
{
  "preview": {
    "html": "example",
    "notificationCount": 1,
    "notifications": [
      {
        "body": "example",
        "createdAt": "2026-04-15T12:00:00Z",
        "title": "example"
      }
    ],
    "recipientName": "example",
    "subject": "example",
    "text": "example"
  }
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}