Skip to content
Vespy API

Get vendor portal dashboard

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
assignedWorkOrders
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
complianceSummary
required
object
expiredCount
required
integer
expiringSoonCount
required
integer
missingRequirements
required
Array<string>
Allowed values: coi w9
status
required
string
Allowed values: compliant warning missing expired
totalDocuments
required
integer
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
vendor
required
object
createdAt
required
string format: date-time
deletedAt
required
string format: date-time
nullable
email
required
string format: email
nullable
id
required
string format: uuid
isActive
required
boolean
name
required
string
>= 1 characters <= 160 characters
notes
required
string
nullable <= 2000 characters
organizationId
required
string format: uuid
phone
required
string
nullable >= 7 characters <= 32 characters
trade
required
string
nullable >= 1 characters <= 120 characters
updatedAt
required
string format: date-time
userId
required
string format: uuid
nullable
Example
{
  "assignedWorkOrders": [
    {
      "category": "plumbing",
      "priority": "low",
      "source": "staff",
      "status": "open"
    }
  ],
  "complianceSummary": {
    "missingRequirements": [
      "coi"
    ],
    "status": "compliant"
  },
  "recentNotifications": [
    {
      "channel": "in_app",
      "channels": [
        "in_app"
      ],
      "priority": "low"
    }
  ]
}

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