Get grouped notification preferences for the current user

GET

/api/notification-preferences

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

preferences

required

Array<object>

object

emailDelivery

required

string

Allowed values: immediate daily_digest

emailEnabled

required

boolean

eventFamily

required

string

Allowed values: maintenance compliance messaging statements payments leasing

inAppEnabled

required

boolean

smsEnabled

required

boolean

Example

{
  "preferences": [
    {
      "emailDelivery": "immediate",
      "eventFamily": "maintenance"
    }
  ]
}

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

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}