Get tenant portal dashboard

GET

/api/tenant/dashboard

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

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

currentBalanceCents

required

integer

currentMonthLedger

required

object

closingBalanceCents

required

integer

openingBalanceCents

required

integer

summary

required

object

netBalanceCents

integer

netIncomeCents

integer

totalChargesCents

integer

totalExpensesCents

integer

totalIncomeCents

integer

totalManagementFeesCents

integer

totalPaymentsCents

integer

transactions

required

Array<object>

object

balanceCents

required

integer

categoryCode

string

nullable >= 1 characters <= 16 characters

categoryName

string

nullable >= 1 characters <= 160 characters

chargeCents

integer

date

required

string format: date

description

required

string

>= 1 characters <= 500 characters

expenseCents

integer

incomeCents

integer

managementFeeCalculation

object

collectedRentCents

required

integer

feeBasisCents

required

integer

feeFlatCents

required

integer

feePercentageBps

required

integer

nullable >= 1 <= 10000

periodEnd

required

string format: date

periodStart

required

string format: date

rentBasisShareBps

required

integer

nullable >= 1 <= 10000

paymentCents

integer

propertyName

string

nullable >= 1 characters <= 160 characters

type

required

string

Allowed values: charge payment income expense

lease

required

object

createdAt

required

string format: date-time

daysUntilExpiry

required

integer

nullable

deletedAt

required

string format: date-time

nullable

endDate

required

string format: date

nullable

id

required

string format: uuid

lateFeeAmountCents

required

integer

nullable >= 1

lateFeeGraceDays

required

integer

lateFeePercentBps

required

integer

nullable >= 1

lateFeeType

required

string

Allowed values: none flat percent

moveInDate

required

string format: date

occupants

required

Array<object>

object

isPrimary

required

boolean

moveInDate

required

string format: date

nullable

moveOutDate

required

string format: date

nullable

providerRole

required

string

nullable

tenantId

required

string format: uuid

tenantName

required

string

>= 1 characters <= 160 characters

organizationId

required

string format: uuid

overduePostedRentCents

integer

propertyId

required

string format: uuid

propertyName

required

string

renewedFromLeaseId

required

string format: uuid

nullable

rentCents

required

integer

>= 1

rentChargeDay

required

integer

>= 1 <= 31

signedAt

required

string format: date-time

nullable

startDate

required

string format: date

status

required

string

Allowed values: draft active ended terminated

tenantId

required

string format: uuid

tenantName

required

string

termType

required

string

Allowed values: fixed month_to_month

terminationDate

required

string format: date

nullable

unitId

required

string format: uuid

unitNumber

required

string

nullable

nextRentAmountCents

required

integer

nullable

nextRentDueDate

required

string format: date

nullable

recentMaintenance

required

Array<object>

object

assignedStaffUserId

required

string format: uuid

nullable

assignedVendorId

required

string format: uuid

nullable

category

required

string

nullable

Allowed values: plumbing electrical hvac appliance structural pest_control landscaping general other

completedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

deletedAt

required

string format: date-time

nullable

description

required

string

nullable

entryInstructions

required

string

nullable

id

required

string format: uuid

organizationId

required

string format: uuid

priority

required

string

Allowed values: low normal high emergency

propertyId

required

string format: uuid

relations

object

assignedStaffUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

assignedVendor

required

object

id

required

string format: uuid

name

required

string

>= 1 characters <= 160 characters

property

required

object

id

required

string format: uuid

name

required

string

>= 1 characters <= 160 characters

tenant

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

unit

required

object

id

required

string format: uuid

unitNumber

required

string

nullable >= 1 characters <= 32 characters

scheduledAt

required

string format: date-time

nullable

source

required

string

Allowed values: staff tenant

status

required

string

Allowed values: open in_progress completed cancelled

subcategory

required

string

nullable <= 100 characters

tenantId

required

string format: uuid

nullable

title

required

string

>= 1 characters <= 160 characters

unitId

required

string format: uuid

nullable

updatedAt

required

string format: date-time

recentNotifications

required

Array<object>

object

actorUser

required

object

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

actorUserId

required

string format: uuid

nullable

body

required

string

nullable

channel

required

string

Allowed values: in_app email sms push

channels

Array<string>

Allowed values: in_app email sms push

createdAt

required

string format: date-time

entityId

required

string format: uuid

nullable

entityType

required

string

nullable

id

required

string format: uuid

priority

required

string

Allowed values: low normal high urgent

readAt

required

string format: date-time

nullable

title

required

string

>= 1 characters

type

required

string

>= 1 characters

tenant

required

object

createdAt

required

string format: date-time

deletedAt

required

string format: date-time

nullable

email

required

string format: email

emergencyContactName

required

string

nullable

emergencyContactPhone

required

string

nullable

emergencyContactRelationship

required

string

nullable

fullName

required

string

>= 1 characters <= 160 characters

id

required

string format: uuid

isActive

required

boolean

organizationId

required

string format: uuid

phone

required

string

nullable

preferredLanguage

required

string

>= 2 characters <= 32 characters

userId

required

string format: uuid

nullable

Example

{
  "currentMonthLedger": {
    "transactions": [
      {
        "type": "charge"
      }
    ]
  },
  "lease": {
    "lateFeeType": "none",
    "status": "draft",
    "termType": "fixed"
  },
  "recentMaintenance": [
    {
      "category": "plumbing",
      "priority": "low",
      "source": "staff",
      "status": "open"
    }
  ],
  "recentNotifications": [
    {
      "channel": "in_app",
      "channels": [
        "in_app"
      ],
      "priority": "low"
    }
  ]
}

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

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

Example^generated

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