Skip to content
Vespy API

Get dashboard summary

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
actionItems
Array<object>
object
dueDate
required
string
nullable
entityId
required
string format: uuid
entityType
required
string
link
required
string
severity
required
string
Allowed values: info warning critical
title
required
string
type
required
string
activeLeases
required
integer
lateRentLeases
required
integer
leaseExpirations
required
object
next180
required
integer
next30
required
integer
next365
required
integer
next60
required
integer
next90
required
integer
maintenanceKpis
object
avgResolutionHours
required
number
nullable
inProgressCount
required
integer
openCount
required
integer
overdueCount
required
integer
messagingOverview
object
unreadConversationCount
required
integer
occupancyRate
required
number
<= 100
occupiedUnits
required
integer
openWorkOrders
required
integer
pastDueRentLeases
Array<object>
object
leaseId
required
string format: uuid
overdueRentCents
required
integer
>= 1
title
required
string
>= 1 characters
properties
required
Array<object>
object
city
required
string
createdAt
required
string format: date-time
id
required
string format: uuid
name
required
string
occupiedUnits
required
integer
openWorkOrderCount
integer
overduePostedRentCents
integer
ownerIds
required
Array<string>
unique items
postalCode
required
string
/^\d{5}(?:-\d{4})?$/
relations
object
owners
required
Array<object>
object
fullName
required
string
>= 1 characters <= 160 characters
id
required
string format: uuid
state
required
string
>= 2 characters <= 2 characters
streetLine1
required
string
>= 1 characters <= 160 characters
streetLine2
required
string
nullable >= 1 characters <= 160 characters
units
required
integer
>= 1
propertyCount
required
integer
totalTenants
required
integer
totalUnits
required
integer
trustSummary
object
lastReconciliationDate
required
string
nullable
lastReconciliationVarianceCents
required
integer
nullable
pendingDispositionCount
required
integer
totalDepositsHeldCents
required
integer
unitStatusBreakdown
required
object
maintenance
required
integer
occupied
required
integer
vacant
required
integer
vendorComplianceSummary
object
compliantCount
required
integer
expiredCount
required
integer
expiringCount
required
integer
Example
{
  "actionItems": [
    {
      "severity": "info"
    }
  ]
}

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