Skip to content
Vespy API

List units across the authenticated organization

GET
/api/units
curl --request GET \
  --url 'https://api.getvespy.com/api/units?status=occupied&sortBy=unitNumber&sortDirection=asc' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string
>= 1 characters <= 100 characters
status
string
Allowed values: occupied vacant maintenance
propertyId
string format: uuid
createdAfter
string format: date
createdBefore
string format: date
minOverdueRentCents
integer
maxOverdueRentCents
integer
minOpenWorkOrders
integer
maxOpenWorkOrders
integer
sortBy
string
Allowed values: unitNumber propertyName bedrooms bathrooms monthlyRentCents status createdAt overduePostedRentCents openWorkOrderCount
sortDirection
string
Allowed values: asc desc

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
noteSummaries
required
Array<object>
object
entityId
required
string format: uuid
latestNote
required
object
body
required
string
>= 1 characters <= 4000 characters
createdAt
required
string format: date-time
visibility
required
string
Allowed values: organization_only tenant_shared vendor_shared tenant_vendor_shared
noteCount
required
integer
units
required
Array<object>
object
accessInstructions
required
string
nullable
bathrooms
required
integer
bedrooms
required
integer
createdAt
required
string format: date-time
currentLease
object
endDate
required
string format: date
nullable
id
required
string format: uuid
rentCents
required
integer
>= 1
startDate
required
string format: date
status
required
string
Allowed values: draft active ended terminated
tenantId
required
string format: uuid
tenantName
required
string
>= 1 characters <= 160 characters
currentTenant
object
email
required
string format: email
fullName
required
string
>= 1 characters <= 160 characters
id
required
string format: uuid
description
required
string
nullable
id
required
string format: uuid
monthlyRentCents
required
integer
>= 1
openWorkOrderCount
integer
overduePostedRentCents
integer
propertyCity
required
string
propertyId
required
string format: uuid
propertyName
required
string
propertyPostalCode
required
string
/^\d{5}(?:-\d{4})?$/
propertyState
required
string
>= 2 characters <= 2 characters
propertyStreetLine1
required
string
>= 1 characters <= 160 characters
propertyStreetLine2
required
string
nullable >= 1 characters <= 160 characters
status
required
string
Allowed values: occupied vacant maintenance
unitNumber
required
string
nullable >= 1 characters <= 32 characters
Example
{
  "noteSummaries": [
    {
      "latestNote": {
        "visibility": "organization_only"
      }
    }
  ],
  "units": [
    {
      "currentLease": {
        "status": "draft"
      },
      "status": "occupied"
    }
  ]
}

400

Section titled “400”

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

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