Skip to content

Get first-run setup progress

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

Default Response

Media typeapplication/json
object
commercialEnabled
required
boolean
counts
required
object
bankAccounts
required
integer
commercialSpacesMissingSqft
required

Commercial spaces with no rentable square footage recorded.

integer
leases
required
integer
properties
required
integer
recoveryPools
required
integer
spaces
required
integer
tenants
required
integer
stripeChargesEnabled
required
boolean
Examplegenerated
{
"commercialEnabled": true,
"counts": {
"bankAccounts": 1,
"commercialSpacesMissingSqft": 1,
"leases": 1,
"properties": 1,
"recoveryPools": 1,
"spaces": 1,
"tenants": 1
},
"stripeChargesEnabled": true
}

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

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