Skip to content
Vespy API

Get organization notification settings

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
settings
required
object
createdAt
required
string format: date-time
id
required
string format: uuid
organizationId
required
string format: uuid
rentReminders
required
object
channels
required
Array<string>
>= 1 items <= 2 items
Allowed values: email sms
daysAfterDue
required
Array<integer>
<= 10 items
daysBeforeDue
required
Array<integer>
<= 10 items
enabled
required
boolean
updatedAt
required
string format: date-time
Example
{
  "settings": {
    "rentReminders": {
      "channels": [
        "email"
      ]
    }
  }
}

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"
}